GetProp

2.x

  HANDLE GetProp(hwnd, lpsz)    
  HWND hwnd; /* handle of window, */  
  LPCSTR 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 string or an atom that identifies a string. If an atom is given, it must be a global atom created by a previous call to the GlobalAddAtom 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 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 value retrieved by the GetProp function can be any 16-bit value useful to the application.

See Also

GlobalAddAtom, RemoveProp, SetProp