4 out of 9 rated this helpful - Rate this topic

AdjustWindowRect function

Applies to: desktop apps only

Calculates the required size of the window rectangle, based on the desired client-rectangle size. The window rectangle can then be passed to the CreateWindow function to create a window whose client area is the desired size.

To specify an extended window style, use the AdjustWindowRectEx function.

Syntax

Copy

BOOL WINAPI AdjustWindowRect(
  __inout  LPRECT lpRect,
  __in     DWORD dwStyle,
  __in     BOOL bMenu
);

Parameters

lpRect [in, out]

Type: LPRECT

A pointer to a RECT structure that contains the coordinates of the top-left and bottom-right corners of the desired client area. When the function returns, the structure contains the coordinates of the top-left and bottom-right corners of the window to accommodate the desired client area.

dwStyle [in]

Type: DWORD

The window style of the window whose required size is to be calculated. Note that you cannot specify the WS_OVERLAPPED style.

bMenu [in]

Type: BOOL

Indicates whether the window has a menu.

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

A client rectangle is the smallest rectangle that completely encloses a client area. A window rectangle is the smallest rectangle that completely encloses the window, which includes the client area and the nonclient area.

The AdjustWindowRect function does not add extra space when a menu bar wraps to two or more rows.

The AdjustWindowRect function does not take the WS_VSCROLL or WS_HSCROLL styles into account. To account for the scroll bars, call the GetSystemMetrics function with SM_CXVSCROLL or SM_CYHSCROLL.

Requirements