ImageGear for C and C++ on Windows v19.1 - Updated
IG_ARTX_richtext_border_get
API Reference Guide > ArtX Component API Reference > ArtX Component Objects Reference > HIG_ARTX_RICHTEXT > IG_ARTX_richtext_border_get

This function queries attributes of annotation border.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_ARTX_richtext_border_get(
        HIG_ARTX_RICHTEXT hMark,
        LPAT_ARTX_BORDER lpBorder,
        LPAT_UINT pnDataSize
);

Arguments:

Name Type Description
hMark HIG_ARTX_RICHTEXT Annotation handle.
lpBorder LPAT_ARTX_BORDER Pointer to storage for the annotation border.
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. If arrow annotation has an arrow head, then its attributes are 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 there is no border, then on output pnDataSize contains zero.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

See AT_ARTX_BORDER structure for additional info.