GetProp

The GetProp function retrieves a data handle from the property list of the given window. The given character string identifies the handle to be retrieved. The string and handle must have been added to the property list by a previous call to the SetProp function.

HANDLE GetProp(
  HWND hWnd,         // handle of window
  LPCTSTR lpString   // atom or address of string
);
 

Parameters

hWnd

Handle to the window whose property list is to be searched.

lpString

Pointer to a null-terminated character string or contains an atom that identifies a string. If this parameter is an atom, it must have been created by using the GlobalAddAtom function. The atom, a 16-bit value, must be placed in the low-order word of the lpString parameter; the high-order word must be zero.

Return Values

If the property list contains the given string, the return value is the associated data handle. Otherwise, the return value is NULL.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in winuser.h.
  Import Library: Use user32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT.

See Also

Window Properties Overview, Window Property Functions, EnumProps, GlobalAddAtom, RemoveProp, SetProp