IG_ARTX_text_textcolor_get

ImageGear for C and C++ on Windows v20.1 - Updated

IG_ARTX_text_textcolor_get

Collapse All

API Reference Guide > ArtX Component API Reference > ArtX Component Objects Reference > HIG_ARTX_TEXT > IG_ARTX_text_textcolor_get

This function queries the annotation text color.

Declaration:

	Copy Code
AT_ERRCOUNT ACCUAPI IG_ARTX_text_textcolor_get( HIG_ARTX_TEXT hMark, LPAT_RGBQUAD lpColor, LPAT_UINT pnDataSize );

Arguments:

Name	Type	Description
hMark	HIG_ARTX_TEXT	Annotation handle.
lpColor	LPAT_RGBQUAD	Pointer to storage that is overwritten with the current text color value.
pnDataSize	LPAT_UINT	Pointer to the variable that on input contains size of buffer specified by lpColor parameter. On output it contains number of bytes copied to lpColor buffer.

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.

Remarks:

If text color is specified for the annotation, then it is copied into output buffer lpColor and number of bytes copied is placed into pnDataSize.
If lpColor is NULL and pnDataSize is not NULL, then on output pnDataSize contains the size of AT_RGBQUAD structure.
If lpColor is not NULL and pnDataSize is not NULL and there is no text color in the annotation, then on output pnDataSize contains zero.

©2024. Accusoft Corporation. All Rights Reserved.

Get Product Support