PROPENUMPROCEXA callback function (winuser.h)

Article
07/27/2022

Application-defined callback function used with the EnumPropsEx function. The function receives property entries from a window's property list. The PROPENUMPROCEX type defines a pointer to this callback function. PropEnumProcEx is a placeholder for the application-defined function name.

Syntax

PROPENUMPROCEXA Propenumprocexa;

BOOL Propenumprocexa(
  HWND unnamedParam1,
  LPSTR unnamedParam2,
  HANDLE unnamedParam3,
  ULONG_PTR unnamedParam4
)
{...}

Parameters

unnamedParam1

Type: HWND

A handle to the window whose property list is being enumerated.

unnamedParam2

Type: LPTSTR

The string component of a property list entry. This is the string that was specified, along with a data handle, when the property was added to the window's property list via a call to the SetProp function.

unnamedParam3

Type: HANDLE

A handle to the data. This handle is the data component of a property list entry.

unnamedParam4

Type: ULONG_PTR

Application-defined data. This is the value that was specified as the lParam parameter of the call to EnumPropsEx that initiated the enumeration.

Return value

Type: BOOL

Return TRUE to continue the property list enumeration.

Return FALSE to stop the property list enumeration.

Remarks

The following restrictions apply to this callback function:

The callback function can call the RemoveProp function. However, RemoveProp can remove only the property passed to the callback function through the callback function's parameters.
The callback function should not attempt to add properties.

Note

The winuser.h header defines PROPENUMPROCEX 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 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	winuser.h (include Windows.h)