GetThreadContext

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

This function retrieves the context of the specified thread.

BOOL GetThreadContext( HANDLE
hThread
,
LPCONTEXT
lpContext
);

Parameters

hThread

Handle to the thread whose context is to be retrieved.

lpContext

Pointer to the CONTEXTstructure that receives the appropriate context of the specified thread. The value of the ContextFlagsmember of this structure specifies which portions of a thread's context are retrieved. The CONTEXTstructure is highly computer specific. Currently, there are CONTEXTstructures defined for Intel, MIPS, Alpha, ARM, SHx, and PowerPC processors. Refer to the header file WINNT.H for definitions of these structures.

Return Values

Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

The GetThreadContextfunction 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 ContextFlagsmember of the CONTEXTstructure. The thread handle identified by the hThreadparameter 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 SuspendThreadfunction to suspend the thread before calling GetThreadContext.

Requirements

Runs On	Versions	Defined in	Include	Link to
Windows CE OS	2.0 and later	Winbase.h		Coredll.lib, Nk.lib

Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

Unicode:Yes