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

Gets the text state of a character or a text element.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_PDE_text_get_state(
        HIG_PDE_TEXT hText,
        UINT nFlags,
        UINT nIndex,
        LPAT_PDE_TEXTSTATE lpTstate 
);

Arguments:

Name Type Description
hText HIG_PDE_TEXT Text object containing a character or text run whose text is examined.
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.
lpTstate LPAT_PDE_TEXTSTATE Pointer to AT_PDE_TEXTSTATE structure to fill with the text state of the specified character or text run.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.