Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

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

Syntax 

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 GlobalAddAtomfunction. The application must place the atom, a 16-bit value, in the low-order word of the lpStringparameter; the high-order word of lpStringmust then be zero.

Return Value

The data handle associated with the specified string indicates that the property list contained the string, and that RemovePropremoved 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 SetPropfunction in the hDataparameter. RemoveProponly destroys the association between the data and the window. RemovePropreturns 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

Header windows.h
Library coredll.lib
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also