ImageGear for C and C++ on Windows v19.2 - Updated
IG_ARTX_action_begin_creation
API Reference Guide > ArtX Component API Reference > ArtX Component Objects Reference > HIG_ARTX_ACTION > IG_ARTX_action_begin_creation

This function creates a GUI action object of type Mark Creation.

Declaration:

 
Copy Code
AT_ERRCOUNT IG_ARTX_action_begin_creation(
        HIG_ARTX_PAGE hArtPage,
        LPAT_ARTX_DRAW_PARAMS pParams,
        LPAT_POINT lpStartPoint,
        HIG_ARTX_MARK hMarkSample,
        enumIGArtXMarkType nMarkType,
        enumIGArtXCoordType nCoordType,
        LPHIG_ARTX_ACTION lphAction
);

Arguments:

Name Type Description
hArtPage HIG_ARTX_PAGE ArtX page handle.
pParams LPAT_ARTX_DRAW_PARAMS Parameters required for action drawing.
lpStartPoint LPAT_POINT Action starting point.
hMarkSample HIG_ARTX_MARK Handle of annotation that will be used as template for the new mark to create. If NULL, then newly created mark will be initialized with default values.
nMarkType enumIGArtXMarkType Type of annotation to create. If hMarkSample is not NULL, then nMarkType value is ignored, and mark of hMarkSample type will be created.
nCoordType enumIGArtXCoordType Coordinate type of mark to create.
lphAction LPHIG_ARTX_ACTION Pointer to storage for the function result.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

This action object helps to create a new annotation and place it on the page.