PropEnumProcEx
Collapse the table of content
Expand the table of content

PropEnumProcEx callback function

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


BOOL CALLBACK PropEnumProcEx(
  _In_ HWND      hwnd,
  _In_ LPTSTR    lpszString,
  _In_ HANDLE    hData,
  _In_ ULONG_PTR dwData
);

Parameters

hwnd [in]

Type: HWND

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

lpszString [in]

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.

hData [in]

Type: HANDLE

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

dwData [in]

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:

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.

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)

Unicode and ANSI names

PropEnumProcExW (Unicode) and PropEnumProcExA (ANSI)

See also

Reference
EnumPropsEx
RemoveProp
SetProp
Conceptual
Window Properties

 

 

Community Additions

ADD
Show:
© 2016 Microsoft