Returns information about the specified thread's stack use.

BOOLEAN GetRtStackInfo(
    RTHANDLE hThread,
    STACKINFO* pInfo
);

Parameters

hThread

Handle for the thread whose stack information you want to obtain.

pInfo

The user-allocated STACKINFO that describes the stack information.

Remarks

The information returned via pInfo is a snapshot of the stack information. Because of the way this information is collected, over time the 'nUsed' field in the STACK_INFO structure only grows.

Return Values

TRUE

Success.

FALSE

Failure. To determine the status, call GetLastRtError.

Status

E_BAD_ADDR

pInfo is invalid.

E_PARAM

cbSize in the structure that pInfo points to is less than sizeof(STACK_INFO).

E_EXISTS

hThread does not represent an existing object.

E_TYPE

hThread is not a handle for a thread.

Requirements