msptiActivityPushExternalCorrelationId
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
Pushes an external correlation ID for the calling thread.
This function notifies MSPTI that the calling thread is entering an external API area. When an MSPTI active API record is created in the external API area and MSPTI_ACTIVITY_KIND_EXTERNAL_CORRELATION is enabled, there is an msptiActivityExternalCorrelation record before the active API record for each msptiExternalCorrelationKind.
Prototype
1 | msptiResult msptiActivityPushExternalCorrelationId(msptiExternalCorrelationKind kind, uint64_t id) |
Options
Option |
Input/Output |
Description |
|---|---|---|
kind |
Input |
Activity type of the external correlation API. The valid kind is xxx_CUSTOM0. Call the enumeration class of the msptiExternalCorrelationKind call. |
id |
Input |
Correlation ID generated by an external component, which is pushed to the stack specified by MSPTI. |
Return Value
MSPTI_SUCCESS indicates a successful operation. MSPTI_ERROR_INVALID_PARAMETER indicates a failure due to an invalid external correlation type, while MSPTI_ERROR_QUEUE_EMPTY indicates a failure caused by attempting to pop from an empty external correlation ID stack.