Graphics::SetClip(constGraphicsPath*,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 the region specified by a graphics path. If a figure in the path is not closed, this method treats the nonclosed figure as if it were closed by a straight line that connects the figure's starting and ending points.

Syntax

Status SetClip(
  [in] const GraphicsPath *path,
  [in] CombineMode        combineMode
);

Parameters

[in] path

Type: const GraphicsPath*

Pointer to a GraphicsPath object that specifies the region to be combined with the clipping region of this Graphics object.

[in] combineMode

Type: CombineMode

Optional. Element of the CombineMode enumeration that specifies how the specified region 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

Requirement Value
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

GraphicsPath

IntersectClip Methods

TranslateClip Methods