PENUM_PAGE_FILE_CALLBACKW callback function (psapi.h)

Article
02/22/2024

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

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

Syntax

PENUM_PAGE_FILE_CALLBACKW PenumPageFileCallbackw;

BOOL PenumPageFileCallbackw(
  [in] LPVOID pContext,
  [in] PENUM_PAGE_FILE_INFORMATION pPageFileInfo,
  [in] LPCWSTR lpFilename
)
{...}

Parameters

[in] pContext

The user-defined data passed from EnumPageFiles.

[in] pPageFileInfo

A pointer to an ENUM_PAGE_FILE_INFORMATION structure.

[in] lpFilename

The name of the pagefile.

Return value

To continue enumeration, the callback function must return TRUE.

To stop enumeration, the callback function must return FALSE.

Remarks

Note

The psapi.h header defines PENUM_PAGE_FILE_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
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	psapi.h