SymGetScopeW function (dbghelp.h)

Article
02/22/2024

Retrieves the scope for the specified index.

Syntax

BOOL IMAGEAPI SymGetScopeW(
  [in]      HANDLE        hProcess,
  [in]      ULONG64       BaseOfDll,
  [in]      DWORD         Index,
  [in, out] PSYMBOL_INFOW Symbol
);

Parameters

[in] hProcess

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

[in] BaseOfDll

The base address of the module.

[in] Index

A unique value for the symbol.

[in, out] Symbol

A pointer to a SYMBOL_INFO structure. The Scope member contains the scope.

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

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.

Note

The dbghelp.h header defines SymGetScope as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

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