ImageGear for C and C++ on Windows v19.1 - Updated
IG_vect_ent_cliprgn_add_path
API Reference Guide > Vector Component API Reference > Vector Component Functions Reference > Entity Functions > IG_vect_ent_cliprgn_add_path

This function appends a new entity to the entity clipping region.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_vect_ent_cliprgn_add_path(
   HIG_VECT_ENTITY hEntity,
   HIG_VECT_ENTITY hClipRgnPath
);

Arguments:

Name Type Description
hEntity HIG_VECT_ENTITY Handle of the entity whose clipping region is expanded.
hClipRgnPath HIG_VECT_ENTITY Entity that will be added to the clipping path.

Return Value:

Returns 0 if successful. Otherwise, returns the number of ImageGear errors that occurred during this function call.

Supported Raster Image Formats:

This function does not process image pixels.

Sample:

None

Remarks:

Entity hClipRgnPath will be converted to the sequence of 3D points to be added to the clipping region data.