TIFFSetField.3tiff - Man Page

set the value(s) of a tag in a TIFF file open for writing

Synopsis

#include <tiffio.h>
#include <stdarg.h>"

int TIFFSetField(TIFF *tif, ttag_t tag, ...)

int TIFFVSetField(TIFF *tif, ttag_t tag, va_list ap)

int TIFFUnsetField(TIFF *tif, uint32_t tag)

Description

TIFFSetField() sets the value of a field or pseudo-tag in the current directory associated with the open TIFF file tif. (A pseudo-tag is a parameter that is used to control the operation of the TIFF library but whose value is not read or written to the underlying file.)  To set the value of a field the file must have been previously opened for writing with TIFFOpen(). Pseudo-tags can be set whether the file was opened for reading or writing. 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.h 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 layered on top of the functionality provided by TIFFSetField().

TIFFUnsetField() clears the contents of the field in the internal structure. If it is a custom field, it is removed from the list of known tags.

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:

Tag Data Types

TypeDescription
char*a null-terminated string corresponding to the ASCII data type
uint16_tan unsigned 16-bit value
uint32_tan unsigned 32-bit value;
uint16_t*an array of unsigned 16-bit values.
void*an array of data values of unspecified type.

Consult the TIFF specification for information on the meaning of each tag.

Tag Properties

Tag nameCountTypesNotes
TIFFTAG_ARTIST1char*
TIFFTAG_BADFAXLINES1uint32_t
TIFFTAG_BITSPERSAMPLE1uint16_t†
TIFFTAG_CLEANFAXDATA1uint16_t
TIFFTAG_COLORMAP3uint16_t*1  <<  BitsPerSample arrays
TIFFTAG_COMPRESSION1uint16_t†
TIFFTAG_CONSECUTIVEBADFAXLINES1uint32_t
TIFFTAG_COPYRIGHT1char*
TIFFTAG_DATETIME1char*
TIFFTAG_DOCUMENTNAME1char*
TIFFTAG_DOTRANGE2uint16_t
TIFFTAG_EXTRASAMPLES2uint16_t, uint16_t*† count, types array
TIFFTAG_FAXFILLFUNC1TIFFFaxFillFuncG3/G4 compression pseudo-tag
TIFFTAG_FAXMODE1int† G3/G4 compression pseudo-tag
TIFFTAG_FILLORDER1uint16_t†
TIFFTAG_GROUP3OPTIONS1uint32_t†
TIFFTAG_GROUP4OPTIONS1uint32_t†
TIFFTAG_HALFTONEHINTS2uint16_t
TIFFTAG_HOSTCOMPUTER1char*
TIFFTAG_ICCPROFILE2uint32_t, void*count, profile data*
TIFFTAG_IMAGEDEPTH1uint32_t†
TIFFTAG_IMAGEDESCRIPTION1char*
TIFFTAG_IMAGELENGTH1uint32_t
TIFFTAG_IMAGEWIDTH1uint32_t†
TIFFTAG_INKNAMES2uint16_t, char*
TIFFTAG_INKSET1uint16_t†
TIFFTAG_JPEGCOLORMODE1int† JPEG pseudo-tag
TIFFTAG_JPEGQUALITY1intJPEG pseudo-tag
TIFFTAG_JPEGTABLES2uint32_t*, void*† count, tables
TIFFTAG_JPEGTABLESMODE1int† JPEG pseudo-tag
TIFFTAG_MAKE1char*
TIFFTAG_MATTEING1uint16_t†
TIFFTAG_MAXSAMPLEVALUE1uint16_t
TIFFTAG_MINSAMPLEVALUE1uint16_t
TIFFTAG_MODEL1char*
TIFFTAG_ORIENTATION1uint16_t
TIFFTAG_PAGENAME1char*
TIFFTAG_PAGENUMBER2uint16_t
TIFFTAG_PHOTOMETRIC1uint16_t
TIFFTAG_PHOTOSHOP?uint32_t, void*count, data
TIFFTAG_PLANARCONFIG1uint16_t†
TIFFTAG_PREDICTOR1uint16_t†
TIFFTAG_PRIMARYCHROMATICITIES1float*6-entry array
TIFFTAG_REFERENCEBLACKWHITE1float*† 6-entry array
TIFFTAG_RESOLUTIONUNIT1uint16_t
TIFFTAG_RICHTIFFIPTC2uint32_t, void*count, data
TIFFTAG_ROWSPERSTRIP1uint32_t† must be > 0
TIFFTAG_SAMPLEFORMAT1uint16_t†
TIFFTAG_SAMPLESPERPIXEL1uint16_t† value must be ≤ 4
TIFFTAG_SMAXSAMPLEVALUE1double
TIFFTAG_SMINSAMPLEVALUE1double
TIFFTAG_SOFTWARE1char*
TIFFTAG_STONITS1double†
TIFFTAG_SUBFILETYPE1uint32_t
TIFFTAG_SUBIFD2uint16_t, uint64_t*count, offsets array
TIFFTAG_TARGETPRINTER1char*
TIFFTAG_THRESHHOLDING1uint16_t
TIFFTAG_TILEDEPTH1uint32_t†
TIFFTAG_TILELENGTH1uint32_t† must be a multiple of 8
TIFFTAG_TILEWIDTH1uint32_t† must be a multiple of 8
TIFFTAG_TRANSFERFUNCTION1 or 3‡uint16_t*1  <<  BitsPerSample entry arrays
TIFFTAG_WHITEPOINT1float*2-entry array
TIFFTAG_XMLPACKET2uint32_t, void*count, data
TIFFTAG_XPOSITION1float
TIFFTAG_XRESOLUTION1float
TIFFTAG_YCBCRCOEFFICIENTS1float*† 3-entry array
TIFFTAG_YCBCRPOSITIONING1uint16_t†
TIFFTAG_YCBCRSAMPLING2uint16_t†
TIFFTAG_YPOSITION1float
TIFFTAG_YRESOLUTION1float
†:

Tag may not have its values changed once data is written.

‡:

If SamplesPerPixel is one, then a single array is passed; otherwise three arrays should be passed.

*:

The contents of this field are quite complex.  See “The ICC Profile Format Specification”, Annex B.3 “Embedding ICC Profiles in TIFF Files” (available at http://www.color.org) for an explanation.

Return Values

1 is returned if the operation was successful. Otherwise, 0 is returned if an error was detected.

Diagnostics

All error messages are directed to the TIFFErrorExtR() routine.

%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

TIFFOpen (3tiff), TIFFGetField (3tiff), TIFFSetDirectory (3tiff), TIFFWriteDirectory (3tiff), TIFFReadDirectory (3tiff), libtiff (3tiff)

Author

LibTIFF contributors

Info

Sep 08, 2023 4.6 LibTIFF