SymSetContext function (dbghelp.h)

Sets context information used by the SymEnumSymbols function. This function only works with PDB symbols.

Syntax

BOOL IMAGEAPI SymSetContext(
  [in]           HANDLE                hProcess,
  [in]           PIMAGEHLP_STACK_FRAME StackFrame,
  [in, optional] PIMAGEHLP_CONTEXT     Context
);

Parameters

[in] hProcess

A handle to a process. This handle must have been previously passed to the SymInitialize function.

[in] StackFrame

A pointer to an IMAGEHLP_STACK_FRAME structure that contains frame information.

[in, optional] Context

This parameter is ignored.

Return value

If the function succeeds, the return value is TRUE.

If the function fails, the return value is FALSE. To retrieve extended error information, call GetLastError.

Remarks

If you call SymSetContext to set the context to its current value, the function fails but GetLastError returns ERROR_SUCCESS.

All DbgHelp functions, such as this one, are single threaded. Therefore, calls from more than one thread to this function will likely result in unexpected behavior or memory corruption. To avoid this, you must synchronize all concurrent calls from more than one thread to this function.

Requirements

Requirement Value
Target Platform Windows
Header dbghelp.h
Library Dbghelp.lib
DLL Dbghelp.dll
Redistributable DbgHelp.dll 5.1 or later

See also

DbgHelp Functions

IMAGEHLP_STACK_FRAME

SymEnumSymbols