Export (0) Print
Expand All
Expand Minimize

GetClientRect function

Retrieves the coordinates of a window's client area. The client coordinates specify the upper-left and lower-right corners of the client area. Because client coordinates are relative to the upper-left corner of a window's client area, the coordinates of the upper-left corner are (0,0).

Syntax


BOOL WINAPI GetClientRect(
  _In_   HWND hWnd,
  _Out_  LPRECT lpRect
);

Parameters

hWnd [in]

Type: HWND

A handle to the window whose client coordinates are to be retrieved.

lpRect [out]

Type: LPRECT

A pointer to a RECT structure that receives the client coordinates. The left and top members are zero. The right and bottom members contain the width and height of the window.

Return value

Type:

Type: BOOL

If the function succeeds, the return value is nonzero.

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

Remarks

In conformance with conventions for the RECT structure, the bottom-right coordinates of the returned rectangle are exclusive. In other words, the pixel at (right, bottom) lies immediately outside the rectangle.

Examples

For example, see Creating, Enumerating, and Sizing Child Windows.

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

See also

Reference
GetWindowRect
Conceptual
Windows
Other Resources
RECT

 

 

Community Additions

ADD
Show:
© 2014 Microsoft