windows_programming_notes.nbk: Home | Index | Next Page: GetCommandLine | Previous Page: GetCapture

 GetClientRect

The 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 GetClientRect(
        HWND   hWnd,
        LPRECT lpRect
     );

Parameters

• hWnd [in]
  Handle to the window whose client coordinates are to be retrieved.
• lpRect
  [out] 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

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.

Function Information

• Minimum DLL Version user32.dll
• Header Declared in Winuser.h, include Windows.h
• Import library User32.lib
• Minimum operating systems Windows 95, Windows NT 3.1
• Unicode Implemented as Unicode version.

windows_programming_notes.nbk: Home | Index | Next Page: GetCommandLine | Previous Page: GetCapture

Notebook exported on Monday, 7 July 2008, 18:56:50 PM Eastern Daylight Time