ImageGear for C and C++ on Linux v18.8 - Updated
IG_PDE_text_get_text
API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > Page Editing Objects and Elements > HIG_PDE_TEXT > IG_PDE_text_get_text

Gets the text for a text run or character.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_PDE_text_get_text(
       HIG_PDE_TEXT hText,
       UINT nFlags,
       UINT nIndex,
       LPBYTE lpText,
       LPUINT lpnTextLen 
);

Arguments:

Name Type Description
hText HIG_PDE_TEXT Text object containing a character or text run whose text is found.
nFlags UINT enumIGPDETextFlags value that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. Must be either:
  • IG_PDE_TEXT_CHAR - for a text character
  • IG_PDE_TEXT_RUN - for a text run
nIndex UINT Index of the character or text run in the text object.
lpText LPBYTE Text of specified character or text run. lpText must be large enough to hold the returned text.
lpnTextLen LPUINT Number of bytes in text run or character.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.