PFIND_DEBUG_FILE_CALLBACK callback function (dbghelp.h)

Article
02/22/2024

An application-defined callback function used with the FindDebugInfoFileEx function. It verifies whether the symbol file located by FindDebugInfoFileEx is the correct symbol file.

The PFIND_DEBUG_FILE_CALLBACK and PFIND_DEBUG_FILE_CALLBACKW types define a pointer to this callback function. FindDebugInfoFileProc is a placeholder for the application-defined function name.

Syntax

PFIND_DEBUG_FILE_CALLBACK PfindDebugFileCallback;

BOOL PfindDebugFileCallback(
  [in] HANDLE FileHandle,
  [in] PCSTR FileName,
  [in] PVOID CallerData
)
{...}

Parameters

[in] FileHandle

A handle to the symbol file.

[in] FileName

The name of the symbol file.

[in] CallerData

Optional user-defined data. This parameter can be NULL.

Return value

If the symbol file is valid, return TRUE. Otherwise, return FALSE.

Remarks

One way to verify the symbol file is to compare its timestamp to the timestamp in the image. To retrieve the timestamp of the image, use the GetTimestampForLoadedLibrary function. To retrieve the timestamp of the symbol file, use the SymGetModuleInfo64 function.

Requirements

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