IG_ARTX_text_border_get

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

IG_ARTX_text_border_get

Collapse All

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

This function queries the annotation border.

Declaration:

	Copy Code
AT_ERRCOUNT ACCUAPI IG_ARTX_text_border_get( HIG_ARTX_TEXT hMark, LPAT_ARTX_BORDER lpBorder, LPAT_UINT pnDataSize );

Arguments:

Name	Type	Description
hMark	HIG_ARTX_TEXT	Annotation handle.
lpBorder	LPAT_ARTX_BORDER	Pointer to storage that is overwritten with the current border value.
pnDataSize	LPAT_UINT	Pointer to the variable that on input contains size of buffer specified by lpBorder parameter. On output it contains number of bytes copied to lpBorder 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 a border is specified for the annotation, then it is copied into output buffer lpBorder, and number of bytes copied is placed into pnDataSize.
If lpBorder is NULL and pnDataSize is not NULL, then on output pnDataSize contains the size of AT_ARTX_BORDER structure.
If lpBorder is not NULL and pnDataSize is not NULL and the annotation lacks a border, then on output pnDataSize contains zero.

©2020. Accusoft Corporation. All Rights Reserved.