EnumProps

2.x

  int EnumProps(hwnd, prpenmprc)    
  HWND hwnd; /* handle of window, */  
  PROPENUMPROC prpenmprc; /* address of callback function */

The EnumProps function enumerates all entries in the property list of the given window. It enumerates the entries by passing them, one by one, to the specified callback function. EnumProps continues until the last entry is enumerated or the callback function returns zero.

Parameters

hwnd

Identifies the window whose property list is enumerated.

prpenmprc

Specifies the procedure-instance address of the callback function. For more information, see the descriptions of the EnumPropFixedProc and EnumPropMovableProc callback functions.

Return Value

The return value specifies the last value returned by the callback function. It is –1 if the function did not find a property to enumerate.

Comments

The form of the callback function depends on whether the application or dynamic-link library (DLL) uses fixed or movable data segments. If the application or library uses fixed data segments (or if the library uses movable data segments that do not contain a stack), see the description of the EnumPropFixedProc callback function. If the application uses movable data segments (or if the library uses movable data segments that also contain a stack), see the description of the EnumPropMovableProc callback function.

An application's EnumPropFixedProc or EnumPropMovableProc callback function should not add new properties to a window. If the callback function deletes a window's properties, it should delete only the property currently being enumerated. The callback function should not delete other properties belonging to the window; if it does, the enumeration process terminates early.

The address passed in the prpenmprc parameter must be created by using the MakeProcInstance function.

See Also

EnumPropFixedProc, EnumPropMovableProc, GetProp, MakeProcInstance, RemoveProp, SetProp