PropEnumProc

The PropEnumProc function is 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.

BOOL CALLBACK PropEnumProc(
  HWND hwnd,           // handle to window whose property list is 
                       // being enumerated
  LPCTSTR lpszString,  // string component of property
  HANDLE hData         // data handle component of property
);
 

Parameters

hwnd

Handle to the window whose property list is being enumerated.

lpszString

Pointer to a null-terminated string. This string is 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

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

Return Values

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 must not yield control or do anything that might yield control to other tasks.
• 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.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in winuser.h.
  Import Library: User-defined.
  Unicode: Defined as Unicode and ANSI prototypes.

See Also

Window Properties Overview, Window Property Functions, EnumProps, EnumPropsEx, PropEnumProcEx, RemoveProp, SetProp