PENUMDIRTREE_CALLBACKW callback function (dbghelp.h)

  • Article

An application-defined callback function used with the EnumDirTree function. It is called every time a match is found.

The PENUMDIRTREE_CALLBACK and PENUMDIRTREE_CALLBACKW types define a pointer to this callback function. EnumDirTreeProc is a placeholder for the application-defined function name.

Syntax

PENUMDIRTREE_CALLBACKW PenumdirtreeCallbackw;

BOOL PenumdirtreeCallbackw(
  [in]           PCWSTR FilePath,
  [in, optional] PVOID CallerData
)
{...}

Parameters

[in] FilePath

A pointer to a buffer that receives the full path of the file that is found.

[in, optional] CallerData

A user-defined value specified in EnumDirTree, or NULL. Typically, this parameter is used by an application to pass a pointer to a data structure that enables the callback function to establish some context.

Return value

To continue enumeration, the callback function must return FALSE.

To stop enumeration, the callback function must return TRUE.

Remarks

Note

The dbghelp.h header defines PENUMDIRTREE_CALLBACK 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 6.0 or later

See also

DbgHelp Functions

EnumDirTree