SymbolRegisteredCallback

The SymbolRegisteredCallback function is an application-defined callback function used with the SymRegisterCallback function. It is called by the symbol handler.

The PSYMBOL_REGISTERED_CALLBACK type defines a pointer to this callback function. SymbolRegisteredCallback is a placeholder for the application-defined function name.

BOOL CALLBACK SymbolRegisteredCallback(
  HANDLE hProcess,     
  ULONG ActionCode,    
  PVOID CallbackData,  
  PVOID UserContext    
);
 

Parameters

hProcess

Handle to the process that was originally passed to the SymInitialize function.

ActionCode

Specifies the reason for the callback. The valid values are:

Value	Meaning
CBA_DEFERRED_SYMBOL_LOAD_START
CBA_DEFERRED_SYMBOL_LOAD_COMPLETE
CBA_DEFERRED_SYMBOL_LOAD_FAILURE
CBA_SYMBOLS_UNLOADED
CBA_DUPLICATE_SYMBOL

CallbackData

Pointer to an action-specific data structure or NULL.

UserContext

A user-defined value specified in SymRegisterCallback, or NULL. Typically, this parameter is used by an application to pass a pointer to a data structure that lets the callback function establish some type of context.

Return Values

Returning the value TRUE indicates success.

Returning the value FALSE indicates failure.

Remarks

The calling application gets called through the registered callback function as a result of another call to one of ImageHlp's symbol handler functions. The calling application must be prepared for the possible side effects that this can cause. If the application has only one callback function that is being used by multiple threads, then care may be necessary to synchronize some types of data access while in the context of the callback function.

QuickInfo

  Windows NT: Requires version 4.0 or later.
  Windows: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Windows CE: Unsupported.
  Header: Declared in imagehlp.h.
  Import Library: User-defined.

See Also

PE Image Helper (ImageHlp) Overview, Symbol Handler, SymRegisterCallback