InvalidateRect (Compact 2013)

3/28/2014

This function adds a rectangle to the specified window's update region. The update region represents the portion of the window's client area that must be redrawn.

Syntax

BOOL InvalidateRect( 
  HWND hWnd, 
  const RECT* lpRect, 
  BOOL bErase
); 

Parameters

• hWnd
  Handle to the window whose update region has changed.

  If you pass a NULL value for this parameter InvalidateRect takes no action and returns FALSE.

• lpRect
  Long pointer to a RECT structure that contains the client coordinates of the rectangle to be added to the update region.

  If this parameter is NULL, the entire client area is added to the update region.

• bErase
  Boolean that specifies whether the background within the update region is to be erased when the update region is processed.

  If this parameter is TRUE, the background is erased when the BeginPaint function is called.

  If this parameter is FALSE, the background remains unchanged.

Return Value

Nonzero indicates success.

Zero indicates failure.

To get extended error information, call GetLastError.

To get extended error information, call GetLastError.

Remarks

The hWnd parameter cannot be NULL.

The invalidated areas accumulate in the update region until the region is processed when the next WM_PAINT message occurs or until the region is validated by using the ValidateRect function.

The system sends a WM_PAINTmessage to a window whenever its update region is not empty and there are no other messages in the application queue for that window.

If the bErase parameter is TRUE for any part of the update region, the background is erased in the entire region, not just in the given part.

Requirements

See Also

Reference

GDI Functions
BeginPaint
ValidateRect
WM_ERASEBKGND
WM_PAINT
RECT