Export (0) Print
Expand All

GetProp function

Retrieves a data handle from the property list of the specified window. The 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.

Syntax


HANDLE WINAPI GetProp(
  _In_  HWND hWnd,
  _In_  LPCTSTR lpString
);

Parameters

hWnd [in]

Type: HWND

A handle to the window whose property list is to be searched.

lpString [in]

Type: LPCTSTR

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 value

Type:

Type: HANDLE

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

Examples

For an example, see Retrieving 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

GetPropW (Unicode) and GetPropA (ANSI)

See also

Reference
GlobalAddAtom
SetProp
Conceptual
Window Properties

 

 

Community Additions

ADD
Show:
© 2014 Microsoft