SymEnumSourceFilesProc Callback Function

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

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

BOOL CALLBACK SymEnumSourceFilesProc(
  [in]                 PSOURCEFILE pSourceFile,
  [in]                 PVOID UserContext
);

Parameters

pSourceFile

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

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

Redistributable	Requires DbgHelp.dll 6.2 or later.
Header	Declared in DbgHelp.h.
Unicode	Implemented as PSYM_ENUMSOURCEFILES_CALLBACKW (Unicode) and PSYM_ENUMSOURCEFILES_CALLBACK (ANSI).

See Also

DbgHelp FunctionsSOURCEFILE
SymEnumSourceFiles

Send comments about this topic to Microsoft

Build date: 9/25/2007