EnumPropsEx function

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

Syntax


int WINAPI EnumPropsEx(
  _In_  HWND hWnd,
  _In_  PROPENUMPROCEX lpEnumFunc,
  _In_  LPARAM lParam
);

Parameters

hWnd [in]

Type: HWND

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

lpEnumFunc [in]

Type: PROPENUMPROCEX

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

lParam [in]

Type: LPARAM

Application-defined data to be passed to the callback 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.

Examples

For an example, see Listing Window Properties for a Given Window.

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

EnumPropsExW (Unicode) and EnumPropsExA (ANSI)

See also

Reference
PropEnumProcEx
Conceptual
Window Properties

 

 

Community Additions

ADD
Show:
© 2015 Microsoft