GetThreadContext

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function retrieves the context of the specified thread.

Syntax

BOOL GetThreadContext(
  HANDLE hThread,
  LPCONTEXT lpContext
);

Parameters

• hThread
  [in] Handle to the thread whose context is to be retrieved.

• lpContext
  [in] Pointer to the 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 processor-specific. Currently, CONTEXT structures are defined for the ARM processors.

  For definitions of these structures, see the Winnt.h header file.

Return Value

Nonzero indicates success. Zero indicates failure. 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.

Requirements

Header	winbase.h
Library	coredll.lib, Nk.lib
Windows Embedded CE	Windows CE 2.0 and later
Windows Mobile	Windows Mobile Version 5.0 and later

See Also

Reference

Process and Thread Functions
SetThreadContext
SuspendThread
CONTEXT