PropEnumProc callback function

An application-defined callback function used with the EnumProps function. The function receives property entries from a window's property list. The PROPENUMPROC type defines a pointer to this callback function. PropEnumProc is a placeholder for the application-defined function name.

Syntax


BOOL CALLBACK PropEnumProc(
  _In_ HWND    hwnd,
  _In_ LPCTSTR lpszString,
  _In_ HANDLE  hData
);

Parameters

hwnd [in]

Type: HWND

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

lpszString [in]

Type: LPCTSTR

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.

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

PropEnumProcW (Unicode) and PropEnumProcA (ANSI)

See also

Reference
EnumProps
RemoveProp
SetProp
Conceptual
Window Properties

 

 

Show: