EnumProps function

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 WINAPI EnumProps(
  _In_ HWND         hWnd,
  _In_ PROPENUMPROC lpEnumFunc
);

Parameters

hWnd [in]

Type: HWND

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

lpEnumFunc [in]

Type: PROPENUMPROC

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

Return value

Type:

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.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winuser.h (include Windows.h)

Library

User32.lib

DLL

User32.dll

Unicode and ANSI names

EnumPropsW (Unicode) and EnumPropsA (ANSI)

See also

Reference
EnumPropsEx
PropEnumProc
Conceptual
Window Properties

 

 

Show: