IG_ARTX_text_text_get

ImageGear for C and C++ on Windows v19.7 - Updated

IG_ARTX_text_text_get

Collapse All

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

This function queries the annotation text string.

Declaration:

	Copy Code
AT_ERRCOUNT ACCUAPI IG_ARTX_text_text_get( HIG_ARTX_TEXT hMark, LPSTR lpszTextBuffer, LPAT_UINT pnDataSize );

Arguments:

Name	Type	Description
hMark	HIG_ARTX_TEXT	Annotation handle.
lpszTextBuffer	LPSTR	Pointer to a buffer that is overwritten with a copy of the annotation text string. Specify NULL to determine the required size of this buffer.
pnDataSize	LPAT_UINT	Pointer to a variable that contains the size of the lpszTextBuffer 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 lpszTextBuffer is NULL, then the number of bytes required to copy the annotation text string is written to pnDataSize.
If lpszTextBuffer is not NULL, then the actual number of bytes copied to lpszTextBuffer is written to pnDataSize.

©2020. Accusoft Corporation. All Rights Reserved.