Export (0) Print
Expand All

SetProp function

Adds a new entry or changes an existing entry in the property list of the specified window. The function adds a new entry to the list if the specified character string does not exist already in the list. The new entry contains the string and the handle. Otherwise, the function replaces the string's current handle with the specified handle.

Syntax


BOOL WINAPI SetProp(
  _In_      HWND hWnd,
  _In_      LPCTSTR lpString,
  _In_opt_  HANDLE hData
);

Parameters

hWnd [in]

Type: HWND

A handle to the window whose property list receives the new entry.

lpString [in]

Type: LPCTSTR

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

hData [in, optional]

Type: HANDLE

A handle to the data to be copied to the property list. The data handle can identify any value useful to the application.

Return value

Type:

Type: BOOL

If the data handle and string are added to the property list, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Before a window is destroyed (that is, before it returns from processing the WM_NCDESTROY message), an application must remove all entries it has added to the property list. The application must use the RemoveProp function to remove the entries.

SetProp is subject to the restrictions of User Interface Privilege Isolation (UIPI). A process can only call this function on a window belonging to a process of lesser or equal integrity level. When UIPI blocks property changes, GetLastError will return 5.

Examples

For an example, see Adding a Window Property.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winuser.h (include Windows.h)

Library

User32.lib

DLL

User32.dll

Unicode and ANSI names

SetPropW (Unicode) and SetPropA (ANSI)

See also

Reference
GlobalAddAtom
RemoveProp
WM_NCDESTROY
Conceptual
Window Properties

 

 

Community Additions

ADD
Show:
© 2014 Microsoft