IG_ARTX_image_reference

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

Declaration:

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

Copy Code

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

Arguments:

Name	Type	Description
pRectangle	LPAT_RECTANGLE	Annotation bounding rectangle.
hGear	HIGEAR	Handle of the image to associate with the new annotation. A copy of the image is created and stored. This parameter can be NULL.
nOrientation	enumIGOrientationModes	Specifies orientation of image within annotation bounding rectangle.
nFitMode	enumFitModes	Specifies fit mode of image.
nAlignmentH	enumAlignModes	Specifies horizontal alignment of image.
nAlignmentV	enumAlignModes	Specifies vertical alignment of image.
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, the image from lpszFileName FILE is used.
pTransparentColor	LPAT_RGBQUAD	Specifies transparent color.
lphMark	HIG_ARTX_IMAGE_REFERENCE	Pointer to storage for new annotation handle.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

Upon successful completion:

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