IG_ARTX_image

This function creates a new instance of image annotation (IG_ARTX_MARK_IMAGE).

Declaration:

	Copy Code
AT_ERRCOUNT ACCUAPI IG_ARTX_image_create( LPAT_RECTANGLE pRectangle, HIGEAR hGear, enumIGOrientationModes nOrientation, enumFitModes nFitMode, enumAlignModes nAlignmentH, enumAlignModes nAlignmentV, AT_FLOAT dAspectRatio, LPSTR lpszFileName, LPAT_RGBQUAD pTransparentColor, LPHIG_ARTX_IMAGE lphMark );

Copy Code

AT_ERRCOUNT ACCUAPI IG_ARTX_image_create(
        LPAT_RECTANGLE pRectangle,
        HIGEAR hGear,
        enumIGOrientationModes nOrientation,
        enumFitModes nFitMode,
        enumAlignModes nAlignmentH,
        enumAlignModes nAlignmentV,
        AT_FLOAT dAspectRatio,
        LPSTR lpszFileName,
        LPAT_RGBQUAD pTransparentColor,
        LPHIG_ARTX_IMAGE lphMark
);

Arguments:

Name	Type	Description
pRectangle	LPAT_RECTANGLE	Annotation bounding rectangle.
hGear	HIGEAR	Handle of image to associate with new annotation. Copy of image is created and stored. This parameter can be NULL.
nOrientation	enumIGOrientationModes	Specifies orientation of image within annotation bounding rectangle. See enumIGOrientationModes.
nFitMode	enumFitModes	Specifies fit mode of image.
nAlignmentH	enumAlignModes	Specifies horizontal alignment of image. See enumAlignModes.
nAlignmentV	enumAlignModes	Specifies vertical alignment of image. See enumAlignModes.
dAspectRatio	AT_FLOAT	Specifies image aspect ratio.
lpszFileName	LPSTR	Specifies name of file with image to associate with annotation. If hGear is not NULL, then lpszFileName is ignored. Otherwise image from lpszFileName FILE is used.
pTransparentColor	LPAT_RGBQUAD	Specifies transparent color.
lphMark	LPHIG_ARTX_IMAGE	Pointer to storage for new annotation handle.

Return Value:

Error count.

Supported Raster Image Formats:

All pixel formats supported by ImageGear for C and C++.

Remarks:

Upon successful completion:

The caller is responsible for deleting the newly created annotation using IG_ARTX_mark_delete.