PDFlib Text Extraction Toolkit (TET) Manual

RPG language binding: the result is provided as Unicode string. If no more text is available
NULL will be returned.
C++ const TET_char_info *get_char_info(int page)
C# Java int get_char_info(int page)
Perl PHP object get_char_info(long page)
VB RB Function get_char_info(int page) As Long
C const TET_char_info *TET_get_char_info(TET *tet, int page)
Get detailed information for the next glyph in the most recent text chunk.
page A valid page handle obtained with TET_open_page( ).
Note The name of this function is a misnomer. It should better be called TET_get_glyph_info( ) since
it reports information about visual glyphs on the page, not the corresponding Unicode
characters.
Returns
Details
If no more glyphs are available for the most recent text fragment returned by TET_get_
text( ), a binding-specific value will be returned. See section Bindings below for more details.
This function can be called one or more times after TET_get_text( ). It will advance to the
next glyph for the current text chunk associated with the supplied page handle (or return
nothing if there are no more glyphs), and provide detailed information for this
glyph. There will be N >0 successful calls to this function (corresponding to N glyphs)
for a text chunk with M logical characters. The relationship between N and M depends
on the granularity:
> For granularity=glyph each text chunk corresponds to a single glyph, i.e. N=1. One
glyph corresponds to one character in many cases, i.e. M=1. However, for ligature
glyphs multiple characters correspond to a single glyph, i.e. M >1 and TET_get_char_
info( ) must be called more than once.
> For granularities other than glyph a sequence of glyphs results in a sequence of characters,
where each glyph may contribute to 0, 1, or more characters. The sequence of
glyphs serves as raw material for the sequence of Unicode characters. In other words,
there is no known relationship between N and M. The relationship between N and M
may be influenced by content analysis (e.g. hyphens are removed by the dehyphenation
process) or Unicode postprocessing (e.g. characters are added or deleted because
of a folding).
For granularities other than glyph this function advances to the next glyph which contributes
to the chunk returned by the most recent call to TET_get_text( ). This way it is
possible to retrieve glyph metrics when the Wordfinder is active and a text chunk may
contain more than one character. In order to retrieve all glyph details for the current
text chunk this function must be called repeatedly until it returns no more info.
The glyph details in the structure or properties/fields are valid until the next call to TET_
get_char_info( ) or TET_close_page( ) with the same page handle (whichever occurs first).
Since there is only a single set of glyph info properties/fields per TET object, clients
must retrieve all glyph info before they call TET_get_char_info( ) again for the same or
another page or document.
178 Chapter 10: TET Library API Reference