msptiActivityPopExternalCorrelationId
Applicability
Product |
Supported (Yes/No) |
|---|---|
Atlas A3 Training Series Product |
Yes |
Atlas A2 Training Series Product/Atlas 800I A2 Inference Product |
Yes |
Atlas 200/500 A2 Inference Product |
Yes |
Atlas Inference Series Product |
x |
Atlas Training Series Product |
x |
Function Description
Pops the external correlation ID for the calling thread.
Prototype
1 | msptiResult msptiActivityPopExternalCorrelationId(msptiExternalCorrelationKind kind, uint64_t *lastId) |
Options
Option |
Input/Output |
Description |
|---|---|---|
kind |
Input |
Activity type of the external correlation API. The valid kind is xxx_CUSTOM0. |
lastId |
Input |
MSPTI pops the ID in the stack and writes it to lastId. |
Return Value
MSPTI_SUCCESS indicates a successful operation, while MSPTI_ERROR_INVALID_PARAMETER indicates a failure caused by an invalid external correlation type.
Parent topic: Function Type