CoGetCallerTID function

Returns a pointer to a DWORD that contains the apartment ID of the caller's thread.

Syntax

HRESULT CoGetCallerTID(
  _Out_ LPDWORD lpdwTID
);

Parameters

lpdwTID [out]

Receives the apartment ID of the caller's thread. For a single threaded apartment (STA), this is the current thread ID. For a multithreaded apartment (MTA), the value is 0. For a neutral apartment (NA), the value is -1.

Return value

This function can return the following values.

Remarks

If the caller is not running on the same computer, this function does not return the apartment ID and the return value is S_FALSE.

There is no guarantee that the information returned from this API is not tampered with, so do not use the ID that is returned to make security decisions. The ID can only be used for logging and diagnostic purposes.

Requirements