PSYMBOLSERVERCALLBACKPROC callback function (dbghelp.h)

  • Article

An entry point to the symbol server DLL.

The PSYMBOLSERVERCALLBACKPROC type defines a pointer to this callback function. SymbolServerCallback is a placeholder for the library-defined function name.

Syntax

PSYMBOLSERVERCALLBACKPROC Psymbolservercallbackproc;

BOOL Psymbolservercallbackproc(
  [in] UINT_PTR action,
  [in] ULONG64 data,
  [in] ULONG64 context
)
{...}

Parameters

[in] action

The action code. This parameter can be one of the following values.

Value Meaning
SSRVACTION_EVENT
3
 Provide debug trace information. The data parameter is a pointer to an IMAGEHLP_CBA_EVENT structure.

DbgHelp 6.0 and earlier:  This value is not supported.
SSRVACTION_QUERYCANCEL
2
 Cancel the file copy. The data parameter is a ULONG64 value. If this value is zero, continue the operation. Otherwise, cancel the operation.

DbgHelp 6.0 and earlier:  This value is not supported.
SSRVACTION_SIZE
5
 The data parameter is the size of the file to be provided by the system.
SSRVACTION_TRACE
1
 Provide debug trace information. The data parameter is a text string.

[in] data

The format of this parameter depends on the value of the action parameter.

[in] context

The context information provided by calling SymbolServerSetOptions with SSRVOPT_SETCONTEXT.

Return value

To indicate success, return TRUE.

To indicate failure, return FALSE and call the SetLastError function to indicate an error condition. If you do not handle a particular action code, you should also return FALSE. (Returning TRUE in this case may have unintended consequences.)

Requirements

Requirement Value
Target Platform Windows
Header dbghelp.h
Redistributable DbgHelp.dll 5.1 or later

See also

DbgHelp Functions

IMAGEHLP_CBA_EVENT