RemoveProp

2.x

  HANDLE RemoveProp(hwnd, lpsz)    
  HWND hwnd; /* handle of window, */  
  LPCSTR lpsz; /* atom or address of string */

The RemoveProp function removes an entry from the property list of the given window. The RemoveProp function returns a data handle so that the application can free the data associated with the handle.

Parameters

hwnd

Identifies the window whose property list is to be changed.

lpsz

Points to a null-terminated string or an atom that identifies a string. If an atom is given, it must be a global atom created by a previous call to the GlobalAddAtom function. The atom, a 16-bit value, must be placed in the low-order word of this parameter; the high-order word must be zero.

Return Value

The return value is the handle of the given string if the function is successful. Otherwise, it is NULL—for example, if the string cannot be found in the given property list.

Comments

An application can remove only those properties it has added. It should not remove properties added by other applications or by Windows itself.

An application must free the data handles associated with entries removed from a property list. The application should remove only those properties it added to the property list.

See Also

GetProp, GlobalAddAtom