The SelectClipPath function selects the current path as a clipping region for a device context, combining the new region with any existing clipping region by using the specified mode.
BOOL SelectClipPath(
| HDC hdc, | // handle of device context |
| int iMode | // clipping mode |
| ); |
Parameters
hdc
Identifies the device context of the path.
iMode
Specifies the way to use the path. The following values are allowed:
| 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. |
Return Values
If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero. To get extended error information, call GetLastError. GetLastError may return one of the following error codes:
ERROR_CAN_NOT_COMPLETE
ERROR_INVALID_PARAMETER
ERROR_NOT_ENOUGH_MEMORY
Remarks
The device context identified by the hdc parameter must contain a closed path.
See Also