PDFlib Text Extraction Toolkit (TET) Manual

10.12 pCOS Functions
The full pCOS syntax for retrieving object data from a PDF is supported. For a detailed
description please refer to the pCOS Path Reference which is available as a separate document.
C++ double pcos_get_number(int doc, wstring path)
C# Java double pcos_get_number(int doc, String path)
Perl PHP float pcos_get_number(int doc, string path)
VB RB Function pcos_get_number(doc as Long, path As String) As Double
C double TET_pcos_get_number(TET *tet, int doc, const char *path, ...)
Get the value of a pCOS path with type number or boolean.
doc A valid document handle obtained with TET_open_document*( ).
path
A full pCOS path for a numerical or boolean 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.
Returns
The numerical value of the object identified by the pCOS path. For Boolean values 1 will
be returned if they are true, and 0 otherwise.
C++ wstring pcos_get_string(int doc, wstring path)
C# Java String pcos_get_string(int doc, String path)
Perl PHP string pcos_get_string(int doc, string path)
VB RB Function pcos_get_string(doc as Long, path As String) As String
C const char *TET_pcos_get_string(TET *tet, int doc, const char *path, ...)
Get the value of a pCOS path with type name, number, string, or boolean.
doc A valid document handle obtained with TET_open_document*( ).
path
A full pCOS path for a string, name, or boolean 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.
Returns
Details
A string with the value of the object identified by the pCOS path. For Boolean values the
strings true or false will be returned.
This function raises an exception if pCOS does not run in full mode and the type of the
object is string. However, the objects /Info/* (document info keys) can also be retrieved in
188 Chapter 10: TET Library API Reference