ImageGear for C and C++ on Windows v19.6 - Updated
IG_PDF_wordfinder_acquire_wordlist
API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > General Objects > HIG_PDF_WORDFINDER > IG_PDF_wordfinder_acquire_wordlist

Finds all words on the specified page.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_PDF_wordfinder_acquire_wordlist(
        HIG_PDF_WORDFINDER hWordFinder, 
                LONG nPageNumber, 
                LPLONG lpnWordCount 
);

Arguments:

Name Type Description
hWordFinder HIG_PDF_WORDFINDER The word finder used to acquire the word list.
nPageNumber LONG The page number for which words are found. First page is 0.
lpnWordCount LPLONG The number of words found on the page.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

Only words within or partially within the page's crop box are enumerated. Words outside the crop box are skipped.

There can be only one word list in existence at a time; clients must release the previous word list, using IG_PDF_wordfinder_release_wordlist, before creating a new one.