EnumPropsW function (winuser.h)

Article
02/22/2024

Enumerates all entries in the property list of a window by passing them, one by one, to the specified callback function. EnumProps continues until the last entry is enumerated or the callback function returns FALSE.

To pass application-defined data to the callback function, use EnumPropsEx function.

Syntax

int EnumPropsW(
  [in] HWND          hWnd,
  [in] PROPENUMPROCW lpEnumFunc
);

Parameters

[in] hWnd

Type: HWND

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

[in] lpEnumFunc

Type: PROPENUMPROC

A pointer to the callback function. For more information about the callback function, see the PropEnumProc function.

Return value

Type: int

The return value specifies the last value returned by the callback function. It is -1 if the function did not find a property for enumeration.

Remarks

An application can remove only those properties it has added. It must not remove properties added by other applications or by the system itself.

Note

The winuser.h header defines EnumProps 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)
Library	User32.lib
DLL	User32.dll