ImageGear Professional DLL v18.1 for Windows
IG_ARTX_text_from_file_text_set
Send Feedback
ImageGear Professional v18.1 > API Reference Guide > ArtX Component API Reference > ArtX Component Objects Reference > HIG_ARTX_TEXTFROMFILE > IG_ARTX_text_from_file_text_set

Glossary Item Box

This function updates the annotation text string.

Declaration:

  Copy Code
AT_ERRCOUNT ACCUAPI IG_ARTX_text_from_file_text_set(
        HIG_ARTX_TEXT_FROM_FILE hMark,
        LPSTR lpszTextBuffer
);

Arguments:

Name Type Description
hMark HIG_ARTX_TEXT_FROM_FILE Annotation handle.
lpszTextBuffer LPSTR A null-terminated string that will be assigned as the annotation text attribute. If lpszTextBuffer is NULL, then the annotation text is assigned the empty string.

Return Value:

Returns the number of ImageGear errors that occurred during this function call. If successful, the return value is 0.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

The value of the text string is the path to a file. The annotation is drawn using the contents of this file.

©2014. Accusoft Corporation. All Rights Reserved.