PDFlib Text Extraction Toolkit (TET) Manual

estricted pCOS mode if nocopy=false or plainmetadata=true, and bookmarks[...]/Title as
well as all paths starting with pages[...]/annots[...]/ can be retrieved in restricted pCOS
mode if nocopy=false.
This function assumes that strings retrieved from the PDF document are text strings.
String objects which contain binary data should be retrieved with TET_pcos_get_stream( )
instead which does not modify the data in any way.
Bindings C language binding: The string will be returned in UTF-8 format (on zSeries and i5/
iSeries: EBCDIC-UTF-8) without BOM. The returned strings will be stored in a ring buffer
with up to 10 entries. If more than 10 strings are queried, buffers will be reused, which
means that clients must copy the strings if they want to access more than 10 strings in
parallel. For example, up to 10 calls to this function can be used as parameters for a
printf( ) statement since the return strings are guaranteed to be independent if no more
than 10 strings are used at the same time.
C++ language binding: The string will be returned as wstring in the default wstring configuration
of the C++ wrapper. In string compatibility mode on zSeries and i5/iSeries the
result will be returned in EBCDIC-UTF-8 without BOM.
Java and .NET bindings: the result will be provided as Unicode string. If no more text is
available a null object will be returned.
Perl, PHP and Python language bindings: the result will be provided as UTF-8 string. If
no more text is available a null object will be returned.
RPG language binding: the result will be provided as EBCDIC-UTF-8 string.
C++ const unsigned char *pcos_get_stream(int doc, int *length, string optlist, wstring path)
C# Java final byte[ ] pcos_get_stream(int doc, String optlist, String path)
Perl PHP string pcos_get_stream(int doc, string optlist, string path)
VB RB Function pcos_get_stream(doc as Long, optlist As String, path As String)
C const unsigned char *TET_pcos_get_stream(TET *tet, int doc, int *length, const char *optlist,
const char *path, ...)
Get the contents of a pCOS path with type stream, fstream, or string.
doc A valid document handle obtained with TET_open_document*( ).
length (C and C++ language bindings only) A pointer to a variable which will receive
the length of the returned stream data in bytes.
optlist An option list specifying stream retrieval options according to Table 10.19.
path
A full pCOS path for a stream or string object.
Additional parameters (C language binding only) A variable number of additional parameters
can be supplied if the key parameter contains corresponding placeholders (%s
for strings or %d for integers; use %% for a single percent sign). Using these parameters
will save you from explicitly formatting complex paths containing variable numerical
or string values. The client is responsible for making sure that the number and type of
the placeholders matches the supplied additional parameters.
10.12 pCOS Functions 189