GetProp

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

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

Parameters

hwnd

Identifies the window whose property list is to be searched.

lpsz

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

Return Value

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

Comments

The GetProp function may be used as either a wide-character function (where text arguments must use Unicode) or an ANSI function (where text arguments must use characters from the Windows 3.x character set installed).

See Also

AddAtom, EnumProps, RemoveProp, SetProp