GetThreadContext info  Overview  Group

The GetThreadContext function retrieves the context of the specified thread.

BOOL GetThreadContext(

HANDLE hThread,	// handle of thread with context
LPCONTEXT lpContext	// address of context structure
);

Parameters

hThread

Identifies an open handle of a thread whose context is to be retrieved.

Windows NT: The handle must have THREAD_GET_CONTEXT access to the thread. For more information, see Thread Objects.

lpContext

Points to the address of a CONTEXT structure that receives the appropriate context of the specified thread. The value of the ContextFlags member of this structure specifies which portions of a thread’s context are retrieved. The CONTEXT structure is highly computer specific. Currently, there are CONTEXT structures defined for Intel, MIPS, Alpha, and PowerPC processors. Refer to the header file WINNT.H for definitions of these structures.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The GetThreadContext function is used to retrieve the context of the specified thread. The function allows a selective context to be retrieved based on the value of the ContextFlags member of the CONTEXT structure. The thread handle identified by the hThread parameter is typically being debugged, but the function can also operate when it is not being debugged.

You cannot get a valid context for a running thread. Use the SuspendThread function to suspend the thread before calling GetThreadContext.

See Also

CONTEXT, SetThreadContext, SuspendThread