CLIP_TO_PATH

  #define CLIP_TO_PATH 4097    

  short Control(lpDevice, CLIP_TO_PATH, lpClipMode, NULL)    
  LPPDEVICE lpDevice;    
  LPINT lpClipMode;    

The CLIP_TO_PATH escape defines a clipping area bounded by the currently open path. It enables the application to save and restore the current clipping area and to set up an inclusive or exclusive clipping area bounded by the currently open path.

Parameters

lpDevice

Points to a PDEVICE structure specifying the destination device.

lpClipMode

Points to a 32-bit variable specifying the clipping mode. It may be one of the following values.

Value Meaning

CLIP_SAVE(0) Saves the current clipping area.
CLIP_RESTORE(1) Restores the previous clipping area.
CLIP_INCLUSIVE(2) Sets a clipping area in such a way that portions of primitives falling outside the interior bounded by the current path are clipped.
CLIP_EXCLUSIVE(3) Sets a clipping area in such a way that portions of primitives falling inside the interior bounded by the current path should be clipped.

The high-order 16 bits specifies the interior mode. It may be either ALTERNATIVE or WINDING.

Return Value

The return value is a nonzero value if the escape is successful. Otherwise, the return value is zero.

Comments

Device drivers implementing the CLIP_TO_PATH escape must also implement the BEGIN_PATH, END_PATH, and EXT_DEVICE_CAPS escapes. Device drivers should also implement the SET_ARC_DIRECTION escape if they support elliptical arcs.

See Also

BEGIN_PATH, END_PATH, EXT_DEVICE_CAPS, SET_ARC_DIRECTION