Edit

IOleInPlaceSiteWindowless::InvalidateRect method (ocidl.h)

  • Article

Enables an object to invalidate a specified rectangle of its in-place image on the screen.

Syntax

HRESULT InvalidateRect(
  [in] LPCRECT pRect,
  [in] BOOL    fErase
);

Parameters

[in] pRect

The rectangle to be invalidated, in client coordinates of the containing window. If this parameter is NULL, the object's full extent is invalidated.

[in] fErase

Specifies whether the background within the update region is to be erased when the region is updated. If this parameter is TRUE, the background is erased. If this parameter is FALSE, the background remains unchanged.

Return value

This method returns S_OK on success.

Remarks

An object is only allowed to invalidate pixels contained in its own site rectangle. Any attempt to invalidate an area outside of that rectangle should result in a no-op.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header ocidl.h

See also

IOleInPlaceSiteWindowless