PFINDFILEINPATHCALLBACKW callback function (dbghelp.h)

  • Article

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

The PFINDFILEINPATHCALLBACK and PFINDFILEINPATHCALLBACKW types define a pointer to this callback function. SymFindFileInPathProc is a placeholder for the application-defined function name.

Syntax

PFINDFILEINPATHCALLBACKW Pfindfileinpathcallbackw;

BOOL Pfindfileinpathcallbackw(
       PCWSTR filename,
  [in] PVOID context
)
{...}

Parameters

filename

The name of the file located by SymFindFileInPath.

[in] context

The user-defined value specified in SymFindFileInPath, or NULL. This parameter is typically used by an application to pass a pointer to a data structure that provides some context for the callback function.

Return value

Return TRUE to continue searching.

Return FALSE to end the search.

Remarks

Note

The dbghelp.h header defines PFINDFILEINPATHCALLBACK as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

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

See also

DbgHelp Functions

SymFindFileInPath