SymSearch function
Searches for PDB symbols that meet the specified criteria.
Syntax
BOOL WINAPI SymSearch( _In_ HANDLE hProcess, _In_ ULONG64 BaseOfDll, _In_opt_ DWORD Index, _In_opt_ DWORD SymTag, _In_opt_ PCTSTR Mask, _In_opt_ DWORD64 Address, _In_ PSYM_ENUMERATESYMBOLS_CALLBACK EnumSymbolsCallback, _In_opt_ PVOID UserContext, _In_ DWORD Options );
Parameters
- hProcess [in]
-
A handle to a process. This handle must have been previously passed to the SymInitialize function.
- BaseOfDll [in]
-
The base address of the module. If this value is zero and Mask contains an exclamation point (!), the function looks across modules. If this value is zero and Mask does not contain an exclamation point, the function uses the scope established by the SymSetContext function.
- Index [in, optional]
-
A unique value for the symbol.
- SymTag [in, optional]
-
The PDB classification. These values are defined in Dbghelp.h in the SymTagEnum enumeration type. For descriptions, see the PDB documentation.
- Mask [in, optional]
-
A wildcard expression that indicates the names of the symbols to be enumerated. To specify a module name, use the !mod syntax.
- Address [in, optional]
-
The address of the symbol.
- EnumSymbolsCallback [in]
-
A SymEnumSymbolsProc callback function that receives the symbol information.
- UserContext [in, optional]
-
A user-defined value that is passed to the callback function, or NULL. This parameter is typically used by an application to pass a pointer to a data structure that provides context for the callback function.
- Options [in]
-
The options that control the behavior of this function.
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.
To call the Unicode version of this function, define DBGHELP_TRANSLATE_TCHAR.
Requirements
|
Redistributable |
DbgHelp.dll 6.2 or later |
|---|---|
|
Header |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names |
SymSearchW (Unicode) and SymSearch (ANSI) |
See also