PDFlib Text Extraction Toolkit (TET) Manual

C++ const TET_char_info *get_char_info(int page)
C# Java int get_char_info(int page)
Perl PHP object TET_get_char_info(resource tet, long page)
VB 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 character in the most recent text fragment.
page A valid page handle obtained with TET_open_page( ).
Returns
Details
Bindings
If no more characters 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 after TET_get_text( ). It will advance to the next character for
the current text fragment associated with the supplied page handle (or return 0 or NULL
if there are no more characters), and provide detailed information for this character.
There will be N successful calls to this function where N is the number of UTF-16 characters
in the text fragment returned by the most recent call to TET_get_text( ).
For granularities other than glyph this function will advance to the next character of
the string returned by the most recent call to TET_get_text( ). This way it is possible to retrieve
character metrics when the wordfinder is active and a text fragment may contain
more than one character. In order to retrieve all character details for the current text
fragment this function must be called repeatedly until it returns NULL or 0.
The character 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 character info properties/fields per TET object,
clients must retrieve all character info before they call TET_get_char_info( ) again for the
same or another page or document.
C and C++ language bindings: If no more characters are available for the most recent
text fragment returned by TET_get_text( ), a NULL pointer will be returned. Otherwise, a
pointer to a TET_char_info structure containing information about a single character
will be returned. The members of the data structure are detailed in Table 10.10.
COM, Java and .NET language bindings: -1 will be returned if no more characters are
available for the most recent text fragment returned by TET_get_text( ), otherwise 1. Individual
character info can be retrieved from the TET properties/public fields according
to Table 10.10. All properties/fields will contain a value of -1 (the unknown field will contain
false) if they are accessed although the function returned -1.
Perl language binding: 0 will be returned if no more characters are available for the
most recent text fragment returned by TET_get_text( ), otherwise a hash containing the
keys listed in Table 10.10. Individual character info can be retrieved with the keys in this
hash.
PHP language binding: an empty (null) object will be returned if no more characters are
available for the most recent text fragment returned by TET_get_text( ), otherwise an object
containing the fields listed in Table 10.10. Individual character info can be retrieved
from the member fields of this object. Integer fields in the character info object are implemented
as long in the PHP language binding.
10.6 Text and Metrics Retrieval Functions 143