This function queries the annotation pin.
Declaration:
 Copy Code |
|
|---|---|
AT_ERRCOUNT ACCUAPI IG_ARTX_text_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 that is overwritten with the pin value. |
| 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. |
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 the annotation has a pin, then it is 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 for this annotation, then on output pnDataSize contains zero.
- See AT_ARTX_PIN structure for additional info.