Share via

CDC::SelectClipPath

  • Article

Selects the current path as a clipping region for the device context, combining the new region with any existing clipping region by using the specified mode.

BOOL SelectClipPath( 
   int nMode  
);

Parameters

  • nMode
    Specifies the way to use the path. The following values are allowed:

    • 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, and those of the current path are 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 Value

Nonzero if the function is successful; otherwise 0.

Remarks

The device context identified must contain a closed path.

Requirements

Header: afxwin.h

See Also

Reference

CDC Class

Hierarchy Chart

CDC::BeginPath

CDC::EndPath