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

This function queries annotation tooltip string.

Declaration:

 
Copy Code 
AT_ERRCOUNT IG_ARTX_mark_tooltip_get(
        HIG_ARTX_MARK hMark,
        LPSTR lpszTextBuffer,
        LPAT_UINT pnBufLength
);

Arguments:

Name Type Description
hMark HIG_ARTX_MARK Annotation handle.
lpszTextBuffer LPSTR Pointer to buffer for output string.
pnBufLength LPAT_UINT Pointer to the variable that on input contains size of buffer specified by lpszTextBuffer parameter. On output it contains number of bytes copied to lpszTextBuffer buffer. If tooltip attribute is not empty in the annotation, then it is copied into output buffer lpszTextBuffer and number of bytes copied is placed into pnDataSize. If lpszTextBuffer is NULL and pnBufLength is not NULL, then on output pnBufLength contains the size required to store annotation text. If lpszTextBuffer is not NULL and pnBufLength is not NULL and there is no tooltip text in the annotation, then on output pnBufLength contains zero.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.

 

 

©2017. Accusoft Corporation. All Rights Reserved.

Send Feedback