IOleInPlaceSiteWindowless::InvalidateRect method

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

pRect [in]

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

fErase [in]

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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

OCIdl.h

IDL

OCIdl.idl

IID

IID_IOleInPlaceSiteWindowless is defined as 922EADA0-3424-11CF-B670-00AA004CD6D8

See also

IOleInPlaceSiteWindowless

 

 

Show: