TIFFSetField(3T) MISC. REFERENCE MANUAL PAGES TIFFSetField(3T)
NAME
TIFFSetField - set the value(s) of a tag in a TIFF file open
for writing
SYNOPSIS
#include <tiffio.h>
int TIFFSetField(TIFF* tif, ttag_t tag, ...)
#include <stdarg.h>
int TIFFVSetField(TIFF* tif, ttag_t tag, va_list ap)
DESCRIPTION
TIFFSetField sets the value of a field in the current direc-
tory associated with the open TIFF file tif. The file must
have been previously opened for writing with TIFFOpen(3T).
The field is identified by tag, one of the values defined in
the include file tiff.h (see also the table below). The
actual value is specified using a variable argument list, as
prescribed by the stdarg(3) interface (or, on some machines,
the varargs(3) interface.)
TIFFVSetField is functionally equivalent to TIFFSetField
except that it takes a pointer to a variable argument list.
TIFFVSetField is useful for writing routines that are lay-
ered on top of the functionality provided by TIFFSetField.
The tags understood by libtiff, the number of parameter
values, and the expected types for the parameter values are
shown below. The data types are: char* is null-terminated
string and corresponds to the ASCII data type; uint16 is an
unsigned 16-bit value; uint32 is an unsigned 32-bit value;
uint16* is an array of unsigned 16-bit values. Consult the
TIFF specification for information on the meaning of each
tag.
Tag Name Count Types Notes
TIFFTAG_ARTIST 1 char*
TIFFTAG_BADFAXLINES 1 uint32
TIFFTAG_BITSPERSAMPLE 1 uint16 -
TIFFTAG_CLEANFAXDATA 1 uint16
TIFFTAG_COLORMAP 3 uint16* 1<<BitsPerSample arrays
TIFFTAG_COMPRESSION 1 uint16 -
TIFFTAG_CONSECUTIVEBADFAXLINES 1 uint32
TIFFTAG_DATETIME 1 char*
TIFFTAG_DOCUMENTNAME 1 char*
TIFFTAG_DOTRANGE 2 uint16
TIFFTAG_EXTRASAMPLES 2 uint16,uint16* - count & types array
TIFFTAG_FILLORDER 1 uint16 -
TIFFTAG_GROUP3OPTIONS 1 uint32 -
TIFFTAG_GROUP4OPTIONS 1 uint32 -
TIFFTAG_HALFTONEHINTS 2 uint16
TIFFTAG_HOSTCOMPUTER 1 char*
TIFFTAG_IMAGEDESCRIPTION 1 char*
Sun Release 4.1 Last change: February 14, 1992 1
TIFFSetField(3T) MISC. REFERENCE MANUAL PAGES TIFFSetField(3T)
TIFFTAG_IMAGEDEPTH 1 uint32 -
TIFFTAG_IMAGELENGTH 1 uint32
TIFFTAG_IMAGEWIDTH 1 uint32 -
TIFFTAG_INKNAMES 1 char*
TIFFTAG_INKSET 1 uint16 -
TIFFTAG_JPEGPROC 1 uint16 -
TIFFTAG_JPEGRESTARTINTERVAL 1 uint16 -
TIFFTAG_JPEGACTABLES 1 u_char** - SamplesPerPixel arrays
TIFFTAG_JPEGDCTABLES 1 u_char** - SamplesPerPixel arrays
TIFFTAG_JPEGQTABLES 1 uint16** - SamplesPerPixel 64-entry arrays
TIFFTAG_MAKE 1 char*
TIFFTAG_MATTEING 1 uint16 -
TIFFTAG_MAXSAMPLEVALUE 1 uint16
TIFFTAG_MINSAMPLEVALUE 1 uint16
TIFFTAG_MODEL 1 char*
TIFFTAG_ORIENTATION 1 uint16
TIFFTAG_PAGENAME 1 char*
TIFFTAG_PAGENUMBER 2 uint16
TIFFTAG_PHOTOMETRIC 1 uint16
TIFFTAG_PLANARCONFIG 1 uint16 -
TIFFTAG_PREDICTOR 1 uint16 -
TIFFTAG_PRIMARYCHROMATICITIES 1 float 6-entry array
TIFFTAG_REFERENCEBLACKWHITE 1 float* - 2*SamplesPerPixel array
TIFFTAG_RESOLUTIONUNIT 1 uint16
TIFFTAG_ROWSPERSTRIP 1 uint32 - must be > 0
TIFFTAG_SAMPLEFORMAT 1 uint16 -
TIFFTAG_SAMPLESPERPIXEL 1 uint16 - value must be <= 4
TIFFTAG_SOFTWARE 1 char*
TIFFTAG_SUBFILETYPE 1 uint32
TIFFTAG_TARGETPRINTER 1 char*
TIFFTAG_THRESHHOLDING 1 uint16
TIFFTAG_TILEDEPTH 1 uint32 -
TIFFTAG_TILELENGTH 1 uint32 - must be a multiple of 8
TIFFTAG_TILEWIDTH 1 uint32 - must be a multiple of 8
TIFFTAG_TRANSFERFUNCTION 1 or 3 = uint16*1<<BitsPerSample entry arrays
TIFFTAG_XPOSITION 1 float
TIFFTAG_XRESOLUTION 1 float
TIFFTAG_WHITEPOINT 1 float 2-entry array
TIFFTAG_YCBCRCOEFFICIENTS 1 float* - 3-entry array
TIFFTAG_YCBCRPOSITIONING 1 uint16 -
TIFFTAG_YCBCRSAMPLING 2 uint16 -
TIFFTAG_YPOSITION 1 float
TIFFTAG_YRESOLUTION 1 float
(- Tag may not have its values changed once data is writ-
ten.) (= If SamplesPerPixel is one, then a single array is
passed; otherwise three arrays should be passed.)
RETURN VALUES
1 is returned if the operation was successful. Otherwise, 0
is returned if an error was detected.
Sun Release 4.1 Last change: February 14, 1992 2
TIFFSetField(3T) MISC. REFERENCE MANUAL PAGES TIFFSetField(3T)
DIAGNOSTICS
All error messages are directed to the TIFFError(3T) rou-
tine.
%s: Cannot modify tag "%s" while writing. Data has already
been written to the file, so the specified tag's value can
not be changed. This restriction is applied to all tags
that affect the format of written data.
%d: Bad value for "%s". An invalid value was supplied for
the named tag.
SEE ALSO
intro(3T), TIFFOpen(3T), TIFFGetField(3T),
TIFFSetDirectory(3T), TIFFWriteDirectory(3T),
TIFFReadDirectory(3T)
Sun Release 4.1 Last change: February 14, 1992 3