Share via

RemoveProp

  • Article

This function removes an entry identified by a specified character string from the property list of a specified window.

HANDLE RemoveProp(
  HWND hWnd,
  LPCTSTR lpString
);

Parameters

  • hWnd
    [in] Handle to the window for which you want to change the property list.
  • lpString
    [in] Pointer to a null-terminated character string that identifies the property that you want to remove, or an atom that identifies the string. If this parameter is an atom, the application must create the atom by using the GlobalAddAtom function. The application must place the atom, a 16-bit value, in the low-order word of the lpString parameter; the high-order word of lpString must then be zero.

Return Values

The data handle associated with the specified string indicates that the property list contained the string, and that RemoveProp removed the association between the property and the window. NULL indicates that the specified string was not found in the specified property list.

Remarks

The return value is an application-defined value that the application passed to the SetProp function in the hData parameter. RemoveProp only destroys the association between the data and the window. RemoveProp returns the data handle associated with the string so that the application can free the data associated with the handle. The application is responsible for freeing these data handles. The application can remove only those properties that the application has added itself. The application should not remove properties that other applications or the operating system added.

Requirements

OS Versions: Windows CE .NET 4.0 and later.
Header: Windows.h.
Link Library: Coredll.lib.

See Also

GlobalAddAtom | GetProp | SetProp

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.