Graphics::SetClip(constRect&,CombineMode) method (gdiplusgraphics.h)

The Graphics::SetClip method updates the clipping region of this Graphics object to a region that is the combination of itself and a rectangle.

Syntax

Status SetClip(
  const Rect & rect,
  CombineMode  combineMode
);

Parameters

rect

Type: const Rect

Reference to a rectangle to be combined with the clipping region of this Graphics object.

combineMode

Type: CombineMode

Element of the CombineMode enumeration that specifies how the specified rectangle is combined with the clipping region of this Graphics object. The default value is CombineModeReplace.

Return value

Type: Status

If the method succeeds, it returns Ok, which is an element of the Status enumeration.

If the method fails, it returns one of the other elements of the Status enumeration.

Requirements

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

See also

Clipping

Clipping with a Region

CombineMode

GetClipBounds Methods

Graphics

Graphics::GetClip

Graphics::IsClipEmpty

Graphics::ResetClip

IntersectClip Methods

Rect

TranslateClip Methods