ImageGear for C and C++ on Windows v19.10 - Updated
IG_ARTX_ruler_label_get
API Reference Guide > ArtX Component API Reference > ArtX Component Objects Reference > HIG_ARTX_RULER > IG_ARTX_ruler_label_get

This function queries annotation label string.

Declaration:

 
Copy Code 
AT_ERRCOUNT ACCUAPI IG_ARTX_ruler_label_get(
        HIG_ARTX_RULER hMark,
        LPSTR lpszTextBuffer,
        LPAT_UINT pnDataSize
);

Arguments:

Name Type Description
hMark HIG_ARTX_RULER Annotation handle.
lpszTextBuffer LPSTR Pointer to buffer for output string.
pnDataSize 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 text 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 pnDataSize is not NULL, then on output pnDataSize contains the size required to store annotation label. If lpszTextBuffer is not NULL and pnDataSize is not NULL and there is no label in the annotation, then on output pnDataSize contains zero.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.

 

 

©2021. Accusoft Corporation. All Rights Reserved.

Send Feedback