SymSearch Function

Searches for PDB symbols that meet the specified criteria.

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          PVOID UserContext,
  __in          DWORD Options
);

Parameters

hProcess

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

BaseOfDll

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

A unique value for the symbol.

SymTag

The PDB classification. These values are defined in Dbghelp.h in the SymTagEnum enumeration type. For descriptions, see the PDB documentation.

Mask

A regular expression that indicates the names of the symbols to be enumerated. To specify a module name, use the !mod syntax.

Address

The address of the symbol.

EnumSymbolsCallback

A SymEnumSymbolsProc callback function that receives the symbol information.

UserContext

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

The options that control the behavior of this function.

Value	Meaning
SYMSEARCH_ALLITEMS 0x08	TBD
SYMSEARCH_GLOBALSONLY 0x04	Search only for global symbols.
SYMSEARCH_MASKOBJS 0x01	For internal use only.
SYMSEARCH_RECURSE 0x02	Recurse from the top to find all symbols.

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.

Requirements

Redistributable	Requires DbgHelp.dll 6.2 or later.
Header	Declared in Dbghelp.h.
Library	Use Dbghelp.lib.
DLL	Requires Dbghelp.dll.
Unicode	Implemented as SymSearchW (Unicode) and SymSearch (ANSI).

See Also

DbgHelp Functions
SymEnumSymbolsProc

Send comments about this topic to Microsoft

Build date: 9/25/2007