Prev Next

GetWindowWord info  Overview  Group

The GetWindowWord function retrieves a 16-bit (word) value at the specified offset into the extra window memory for the specified window.

The GWW_ values supported by 16-bit Windows are obsolete. You must use the GetWindowLong function to retrieve information about the window.

WORD GetWindowWord(

    HWND hWnd,

// handle of window

    int nIndex 

// offset of value to retrieve

   );

Parameters

hWnd
Identifies the window and, indirectly, the class to which the window belongs.
nIndex
Specifies the zero-based byte offset of the value to be retrieved. Valid values are in the range zero through the number of bytes of extra window memory, minus two; for example, if you specified 10 or more bytes of extra window memory, a value of 8 would be an index to the fifth 16-bit integer.

Return Values

If the function succeeds, the return value is the requested 16-bit value.

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

Remarks

Reserve extra window memory by specifying a nonzero value in the cbWndExtra member of the WNDCLASS structure used with the RegisterClass function.

See Also

GetParent, GetWindowLong, RegisterClass, SetParent, SetWindowLong, SetWindowWord, WNDCLASS