nf-wingdi-selectclippath.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:wingdi.SelectClipPath	SelectClipPath function (wingdi.h)	The SelectClipPath function selects the current path as a clipping region for a device context, combining the new region with any existing clipping region using the specified mode.	RGN_AND RGN_COPY RGN_DIFF RGN_OR RGN_XOR SelectClipPath SelectClipPath function [Windows GDI] _win32_SelectClipPath gdi.selectclippath wingdi/SelectClipPath	gdi\selectclippath.htm	gdi	c5102e1b-ba33-4cce-a4e5-93cf10c1c0bb	12/05/2018	RGN_AND, RGN_COPY, RGN_DIFF, RGN_OR, RGN_XOR, SelectClipPath, SelectClipPath function [Windows GDI], _win32_SelectClipPath, gdi.selectclippath, wingdi/SelectClipPath	wingdi.h	Windows.h	Windows	Windows 2000 Professional [desktop apps only]	Windows 2000 Server [desktop apps only]										Gdi32.lib	Gdi32.dll		Windows			19H1	SelectClipPath wingdi/SelectClipPath	c++	APIRef kbSyntax	DllExport	gdi32.dll Ext-MS-Win-GDI-DC-l1-2-0.dll ext-ms-win-gdi-dc-l1-2-1.dll GDI32Full.dll	SelectClipPath

SelectClipPath function

-description

The SelectClipPath function selects the current path as a clipping region for a device context, combining the new region with any existing clipping region using the specified mode.

-parameters

-param hdc [in]

A handle to the device context of the path.

-param mode [in]

The way to use the path. This parameter can be one of the following values.

Value	Meaning
RGN_AND	The new clipping region includes the intersection (overlapping areas) of the current clipping region and the current path.
RGN_COPY	The new clipping region is the current path.
RGN_DIFF	The new clipping region includes the areas of the current clipping region with those of the current path excluded.
RGN_OR	The new clipping region includes the union (combined areas) of the current clipping region and the current path.
RGN_XOR	The new clipping region includes the union of the current clipping region and the current path but without the overlapping areas.

-returns

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero.

-remarks

The device context identified by the hdc parameter must contain a closed path.

Examples

For an example, see Using Clipping.

-see-also

BeginPath

Clipping Functions

Clipping Overview

EndPath