PDFlib Text Extraction Toolkit (TET) Manual

C++ int write_image_file(int doc, int imageid, string optlist)
C# Java int write_image_file(int doc, int imageid, String optlist)
Perl PHP long TET_write_image_file(resource tet, long doc, long imageid, string optlist)
VB Function write_image_file(doc As Long, imageid As Long, optlist As String) As Long
C
int TET_write_image_file(TET *tet, int doc, int imageid, const char *optlist)
Write image data to disk.
doc A valid document handle obtained with TET_open_document*( ).
imageid The pCOS ID of the image. This ID can be retrieved from the imageid field after
a successful call to TET_get_image_info( ), or by looping over all entries in the images
pseudo object (there are length:images entries in this array).
optlist An option list specifying page options according to Table 10.12. The following
options can be used: compression, filename, format, keepxmp, typeonly.
Returns
Details
Bindings
-1 on error, or a value greater than 0 otherwise. If -1 is returned it is recommended to call
TET_get_errmsg( ) to find out more details about the error. No image output will be created
in case of an error. The rare case of images in an unsupported format will also be reported
as an error. If the return value is different from -1 it indicates that the image can
be extracted in the file format indicated by the return value:
> -1: an error occurred; no image will be extracted
> 10: image extracted as TIFF (.tif)
> 20: image extracted as JPEG (.jpg)
> 30: image extracted as JPEG 2000 (.jpx)
This function will convert the pixel data for the image with the specified pCOS ID to one
of several image formats, and write the result to a disk file. If the typeonly option has
been supplied, only the image type will be returned, but no image file will be generated.
C/C++: macros for the return values are available in tetlib.h.
Table 10.12 Options for TET_write_image_file( ) and TET_get_image_data( )
option
compression
filename 1
keepxmp
typeonly 1
description
(Keyword) The algorithm for compressing the pixel data (default: auto):
auto select a suitable compression algorithm automatically
none (Only relevant for TIFF images) Write the pixel data without any compression if possible.
(String; required unless typeonly is also supplied) The name of the image file on disk. A suffix will be added
to the filename to indicate the image file format.
(Boolean) If true and the image has associated XMP metadata in the PDF, the metadata will be embedded
in extracted TIFF and JPEG images. Default: true
(Boolean) The image type will be determined according to the supplied options, but no image file will be
written. This is useful for determining the type of image returned by TET_get_image_data( ), which does
not return the image type itself. Default: false
1. Only for TET_write_image_file( )
10.7 Image Retrieval Functions 147