PDFlib Text Extraction Toolkit (TET) Manual

10.4 Document Functions
C++ int open_document(string filename, string optlist)
C# Java int open_document(String filename, String optlist)
Perl PHP long TET_open_document(resource tet, string filename, string optlist)
VB Function open_document(filename As String, optlist As String) As Long
C
int TET_open_document(TET *tet, const char *filename, int len, const char *optlist)
Open a disk-based or virtual PDF document for content extraction.
filename (Name string, but Unicode file names are only supported on Windows) Absolute
or relative name of the PDF input file to be processed. The file will be searched in all
directories specified in the searchpath resource category. On Windows it is OK to use
UNC paths or mapped network drives. In PHP Unicode filenames must be UTF-8.
In non-Unicode language bindings file names with len = 0 will be interpreted in the
current system codepage unless they are preceded by a UTF-8 BOM, in which case they
will be interpreted as UTF-8 or EBCDIC-UTF-8.
len (Only C language binding) Length of filename (in bytes) for UTF-16 strings. If len = 0
a null-terminated string must be provided.
optlist An option list specifying document options according to Table 10.3. The following
options can be used:encodinghint, glyphmapping, keeppua, inmemory, password, repair,
requiredmode, shrug, tetml, unknownchar, usehostfonts.
Returns
Details
-1 on error, or a document handle otherwise. For example, it is an error if the input document
or the TETML output file cannot be opened. If -1 is returned it is recommended to
call TET_get_errmsg( ) to find out more details about the error.
Within a single TET object an arbitrary number of documents may be kept open at the
same time. However, a single TET object must not be used in multiple threads simultaneously
without any locking mechanism for synchronizing the access.
Encryption: if the document is encrypted its user password must be supplied in the
password option if the permission settings allow content extraction. The document’s
master password must be supplied if the permission settings do not allow content extraction.
If the requiredmode option has been specified, documents can be opened even
without the appropriate password, but operations are restricted. The shrug option can
be used to enable content extraction from protected documents under certain conditions
(see Section 5.1, »Indexing protected PDF Documents«, page 49).
Supported file systems on iSeries: TET has been tested with PC type file systems only.
Therefore input and output files should reside in PC type files in the IFS (Integrated File
System). The QSYS.lib file system for input files has not been tested and is not supported.
Since QSYS.lib files are mostly used for record-based or database objects, unpredictable
behavior may be the result if you use TET with QSYS.lib objects. TET file I/O is always
stream-based, not record-based.
10.4 Document Functions 129