ImageGear for C and C++ on Linux v20.0 - Updated
API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > General Objects > HIG_PDF_WORD > IG_PDF_word_get_string

Gets a word's text and also converts ligatures to their constituent characters.


Copy Code
        HIG_PDF_WORD hWord, 
                LPCHAR lpString, 
                LONG nLen 


Name Type Description
hWord HIG_PDF_WORD The word whose string is obtained.
lpString LPCHAR The word string. The encoding of the string is the encoding used by the PDF WordFinder that supplied the PDF Word. For instance, if IG_PDF_doc_create_wordfinder_ucs is used to create the word finder, this function returns only Unicode.
nLen LONG Length of string, in bytes. Up to nLen characters of word will be copied into lpString. If lpString is long enough, it will be null-terminated.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.


The string to return includes any word break characters (such as space characters) that follow the word, but not any that precede the word. The characters that are treated as word breaks are defined in the outEncInfo parameter of IG_PDF_doc_create_wordfinder function.

This function produces a string in whatever encoding the PDF Word uses, for both Roman and non-Roman systems.

Is this page helpful?
Yes No
Thanks for your feedback.