SymSetContext Function

Debug Help Library

SymSetContext Function

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

BOOL WINAPI SymSetContext(
  __in          HANDLE hProcess,
  __in          PIMAGEHLP_STACK_FRAME StackFrame,
  __in          PIMAGEHLP_CONTEXT Context
);

Parameters

hProcess

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

StackFrame

A pointer to an IMAGEHLP_STACK_FRAME structure that contains frame information.

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

Redistributable

Requires DbgHelp.dll 5.1 or later.

Header

Declared in Dbghelp.h.

Library

Use Dbghelp.lib.

DLL

Requires Dbghelp.dll.

See Also

DbgHelp FunctionsIMAGEHLP_STACK_FRAME
SymEnumSymbols


Send comments about this topic to Microsoft

Build date: 9/25/2007

© 2007 Microsoft Corporation. All rights reserved.