PSYM_ENUMSOURCEFILES_CALLBACK callback function (dbghelp.h)

An application-defined callback function used with the SymEnumSourceFiles function.

The PSYM_ENUMSOURCEFILES_CALLBACK and PSYM_ENUMSOURCEFILES_CALLBACKW types define a pointer to this callback function. SymEnumSourceFilesProc is a placeholder for the application-defined function name.

Syntax

PSYM_ENUMSOURCEFILES_CALLBACK PsymEnumsourcefilesCallback;

BOOL PsymEnumsourcefilesCallback(
  [in]           PSOURCEFILE pSourceFile,
  [in, optional] PVOID UserContext
)
{...}

Parameters

[in] pSourceFile

A pointer to a SOURCEFILE structure that provides information about the source file.

[in, optional] UserContext

The user-defined value passed from the SymEnumSourceFiles 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

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

See also

DbgHelp Functions

SOURCEFILE

SymEnumSourceFiles