ImageGear for C and C++ on Windows v19.6 - Updated
IG_ARTX_text_pinup_pin_get
API Reference Guide > ArtX Component API Reference > ArtX Component Objects Reference > HIG_ARTX_PINUPTEXT > IG_ARTX_text_pinup_pin_get

This function queries attributes of annotation pin.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_ARTX_text_pinup_pin_get(
        HIG_ARTX_TEXT hMark,
        LPAT_ARTX_PIN lpPin,
        LPAT_UINT pnDataSize
);

Arguments:

Name Type Description
hMark HIG_ARTX_TEXT Annotation handle.
lpPin LPAT_ARTX_PIN Pointer to storage for the annotation pin.
pnDataSize LPAT_UINT Pointer to the variable that on input contains size of buffer specified by lpPin parameter. On output it contains number of bytes copied to lpPin buffer. If annotation has a pin, then its attributes are copied into output buffer lpPin and number of bytes copied is placed into pnDataSize. If lpPin is NULL and pnDataSize is not NULL, then on output pnDataSize contains the size of AT_ARTX_PIN structure. If lpPin is not NULL and pnDataSize is not NULL and there is no pin, 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_PIN structure for additional info.