Windows Dev Center

Expand Minimize

SymEnumSymbolsProc callback function

An application-defined callback function used with the SymEnumSymbols, SymEnumTypes, and SymEnumTypesByName functions.

The PSYM_ENUMERATESYMBOLS_CALLBACK and PSYM_ENUMERATESYMBOLS_CALLBACKW types define a pointer to this callback function. SymEnumSymbolsProc is a placeholder for the application-defined function name.

Syntax


BOOL CALLBACK SymEnumSymbolsProc(
  _In_     PSYMBOL_INFO pSymInfo,
  _In_     ULONG        SymbolSize,
  _In_opt_ PVOID        UserContext
);

typedef BOOL (CALLBACK *PSYM_ENUMERATESYMBOLS_CALLBACKW)(
    _In_     PSYMBOL_INFOW pSymInfo,
    _In_     ULONG         SymbolSize,
    _In_opt_ PVOID         UserContext
);

Parameters

pSymInfo [in]

A pointer to a SYMBOL_INFO structure that provides information about the symbol.

SymbolSize [in]

The size of the symbol, in bytes. The size is calculated and is actually a guess. In some cases, this value can be zero.

UserContext [in, optional]

The user-defined value passed from the SymEnumSymbols or SymEnumTypes function, or NULL. This parameter is typically used by an application to pass a pointer to a data structure that provides context information for the callback function.

Return value

If the function returns TRUE, the enumeration will continue.

If the function returns FALSE, the enumeration will stop.

Requirements

Redistributable

DbgHelp.dll 5.1 or later

Header

DbgHelp.h

Unicode and ANSI names

PSYM_ENUMERATESYMBOLS_CALLBACKW (Unicode) and PSYM_ENUMERATESYMBOLS_CALLBACK (ANSI)

See also

DbgHelp Functions
SYMBOL_INFO
SymEnumSymbols
SymEnumTypes
SymEnumTypesByName

 

 

Community Additions

ADD
Show:
© 2015 Microsoft