ValidateRect function

The ValidateRect function validates the client area within a rectangle by removing the rectangle from the update region of the specified window.

Syntax

BOOL ValidateRect(
  HWND       hWnd,
  const RECT *lpRect
);

Parameters

hWnd

Handle to the window whose update region is to be modified. If this parameter is NULL, the system invalidates and redraws all windows and sends the WM_ERASEBKGND and WM_NCPAINT messages to the window procedure before the function returns.

lpRect

Pointer to a RECT structure that contains the client coordinates of the rectangle to be removed from the update region. If this parameter is NULL, the entire client area is removed.

Return Value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero.

Remarks

The BeginPaint function automatically validates the entire client area. Neither the ValidateRect nor ValidateRgn function should be called if a portion of the update region must be validated before the next WM_PAINT message is generated.

The system continues to generate WM_PAINT messages until the current update region is validated.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header winuser.h (include Windows.h)
Library User32.lib
DLL User32.dll

See Also

BeginPaint

InvalidateRect

InvalidateRgn

Painting and Drawing Functions

Painting and Drawing Overview

RECT

ValidateRgn

WM_PAINT