PDFlib Text Extraction Toolkit (TET) Manual

Trailer data, i.e. document-specific data after the last page, must be requested with
the trailer suboption when this function is called for the last time for a document. Trailer
data can be created with a separate call after the last page (pagenumber=0), or together
with the last page (pagenumber is different from 0). Pages can be retrieved in any order,
and any subset of the document’s pages can be retrieved.
It is an error to call TET_close_document( ) without retrieving the trailer, or to call TET_
process_page( ) again after retrieving the trailer.
C++ const char *get_xml_data(int doc, size_t *length, string optlist)
C# Java final byte[ ] get_xml_data(int doc, String optlist)
Perl PHP string TET_get_xml_data(resource tet, long doc, string optlist)
VB Function get_xml_data(doc As Long, optlist As String)
C const char * TET_get_xml_data(TET *tet, int doc, size_t *length, const char *optlist)
Retrieve TETML data from memory.
doc A valid document handle obtained with TET_open_document*( ).
length (C and C++ language binding only) A pointer to a variable which will hold the
length of the returned string in bytes. length does not count the terminating null byte.
optlist
(Currently there are no supported options.)
Returns
A byte array containing the next chunk of data according to the specified options. If the
buffer is empty an empty string will be returned (in C: a NULL pointer and *len=0).
Details This functions retrieves TETML data which has been created by TET_open_document*( )
and one or more calls to TET_process_page( ). The TETML data will always be encoded in
UTF-8, regardless of the outputformat option. The internal buffer will be cleared by this
call. It is not required to call TET_get_xml_data( ) after each call to TET_process_page( ).
The client may accumulate the data for one or more pages or for the whole document in
the buffer.
In TETML mode this function must be called at least once before TET_close_
document( ) since otherwise the data would no longer be accessible. If TET_get_xml_
data( ) is called exactly once (such a single call must happen between the last call to TET_
process_page( ) and TET_close_document( )) the buffer is guaranteed to contain wellformed
TETML output for the whole document.
This function must not be called if the filename suboption has been supplied to the
tetml option of TET_open_document*( ).
Bindings
C and C++ language bindings: the result will be provided as null-terminated UTF-8. On
iSeries and zSeries EBCDIC-encoded UTF-8 will be returned. The returned data buffer can
be used until the next call toTET_get_xml_data( ).
Java and .NET language bindings: the result will be provided as a byte array containing
UTF-8 data.
COM: Most client programs will use the Variant type to hold the UTF-8 data.
PHP language binding: the result will be provided as UTF-8 string.
RPG language binding: the result will be provided as null-terminated EBCDIC-encoded
UTF-8.
150 Chapter 10: TET Library API Reference