Misc. Reference Manual Pages TIFFSetField(3tiff)
NAME
TIFFSetField, TIFFVSetField - set the value(s) of a tag in a
TIFF file open for writingSYNOPSIS
#include
int TIFFSetField(TIFF* tif, ttag_t tag, ...)
#include
int TIFFVSetField(TIFF* tif, ttag_t tag, va_list ap)
TIFFSetField sets the value of a field or pseudo-tag in the
current directory associated with the open TIFF file. Apseudo-tag is a parameter that is used to control the opera-
tion 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 previ-
ously opened for writing with TIFFOpen(3tiff). Pseudo-tags
can be set whether the file was opened for reading or writ-
ing. 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.EXTENDED DESCRIPTION
TIFFVSetField is functionally equivalent to TIFFSetField
except that TIFFVSetField 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. 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 as follows: char*Null-terminated string, corresponds to the ASCII data
type uint16Unsigned 16-bit value
SunOS 5.10 Last change: 05 Apr 2004 1 Misc. Reference Manual Pages TIFFSetField(3tiff) uint32Unsigned 32-bit value
uint16*Array of unsigned 16-bit values
void* Array of data values of unspecified typeConsult the TIFF specification for information on the mean-
ing of each tag. SunOS 5.10 Last change: 05 Apr 2004 2 Misc. Reference Manual Pages TIFFSetField(3tiff) SunOS 5.10 Last change: 05 Apr 2004 3 Misc. Reference Manual Pages TIFFSetField(3tiff)__________________________________________________________________________________________________
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<
__________________________________________________________________________________________________
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 and types array
__________________________________________________________________________________________________
TIFFTAG_FAXMODE 1 int - G3/G4 compression pseudo-
tag__________________________________________________________________________________________________
TIFFTAG_FAXFILLFUNC 1 TIFFFaxFillFunc G3/G4 compression pseudo-tag
__________________________________________________________________________________________________
TIFFTAG_FILLORDER 1 uint16 -
__________________________________________________________________________________________________
TIFFTAG_GROUP3OPTIONS 1 uint32 -
__________________________________________________________________________________________________
TIFFTAG_GROUP4OPTIONS 1 uint32 -
__________________________________________________________________________________________________
TIFFTAG_HALFTONEHINTS 2 uint16
__________________________________________________________________________________________________
TIFFTAG_HOSTCOMPUTER 1 char*
__________________________________________________________________________________________________
TIFFTAG_IMAGEDEPTH 1 uint32 -
__________________________________________________________________________________________________
TIFFTAG_IMAGEDESCRIPTION 1 char*
__________________________________________________________________________________________________
TIFFTAG_IMAGELENGTH 1 uint32
__________________________________________________________________________________________________
TIFFTAG_IMAGEWIDTH 1 uint32 -
__________________________________________________________________________________________________
TIFFTAG_INKNAMES 1 char*
__________________________________________________________________________________________________
TIFFTAG_INKSET 1 uint16 -
__________________________________________________________________________________________________
SunOS 5.10 Last change: 05 Apr 2004 4 Misc. Reference Manual Pages TIFFSetField(3tiff)TIFFTAG_JPEGTABLES 2 uint32*,void* - count and tables
__________________________________________________________________________________________________
TIFFTAG_JPEGQUALITY 1 int JPEG pseudo-tag
__________________________________________________________________________________________________
TIFFTAG_JPEGCOLORMODE 1 int - JPEG pseudo-tag
__________________________________________________________________________________________________
TIFFTAG_JPEGTABLESMODE 1 int - JPEG pseudo-tag
__________________________________________________________________________________________________
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_PRIMARYCHROMACITIES 1 float* 6-entry array
__________________________________________________________________________________________________
TIFFTAG_REFERENCEBLACKWHITE 1 float* - 2*SamplesPerPixel array
__________________________________________________________________________________________________
TIFFTAG_RESOLUTIONUNIT 1 uint16
__________________________________________________________________________________________________
TIFFTAG_ROWSPERSTRIP 1 uint32 - must be greater than 0
__________________________________________________________________________________________________
TIFFTAG_SAMPLEFORMAT 1 uint16 -
__________________________________________________________________________________________________
TIFFTAG_SAMPLESPERPIXEL 1 uint16 - value must be <= 4
__________________________________________________________________________________________________
TIFFTAG_SMAXSAMPLEVALUE 1 double
__________________________________________________________________________________________________
TIFFTAG_SMINSAMPLEVALUE 1 double
__________________________________________________________________________________________________
TIFFTAG_SOFTWARE 1 char*
__________________________________________________________________________________________________
TIFFTAG_STONITS 1 double -
__________________________________________________________________________________________________
TIFFTAG_SUBFILETYPE 1 uint32
__________________________________________________________________________________________________
SunOS 5.10 Last change: 05 Apr 2004 5 Misc. Reference Manual Pages TIFFSetField(3tiff)TIFFTAG_SUBIFD 2 uint16,uint32* count and offsets array
|_______________________________|________________|_________________|______________________________|
| TIFFTAG_TARGETPRINTER | 1 | char* | |
|_______________________________|________________|_________________|______________________________|
| TIFFTAG_THRESHOLDING | 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<
| | | | arrays | |_______________________________|________________|_________________|______________________________|
| TIFFTAG_WHITEPOINT | 1 | float* | 2-entry array |
|_______________________________|________________|_________________|______________________________|
| TIFFTAG_XPOSITION | 1 | float | |
|_______________________________|________________|_________________|______________________________|
| TIFFTAG_XRESOLUTION | 1 | float | |
|_______________________________|________________|_________________|______________________________|
| TIFFTAG_YCBCRCOEFFICIENTS | 1 | float* | - 3-entry array |
|_______________________________|________________|_________________|______________________________|
| TIFFTAG_YCBCRPOSITIONING | 1 | uint16 | - |
|_______________________________|________________|_________________|______________________________|
| TIFFTAG_YCBCRSUBSAMPLING | 2 | uint16 | - |
|_______________________________|________________|_________________|______________________________|
| TIFFTAG_YPOSITION | 1 | float | |
|_______________________________|________________|_________________|______________________________|
| TIFFTAG_YRESOLUTION | 1 | float | |
|_______________________________|________________|_________________|______________________________|
| TIFFTAG_ICCPROFILE | 2 | uint32,void* | count, profile data+ |
|_______________________________|________________|_________________|______________________________|
- Tag may not have its values changed
once data is written.= If SamplesPerPixel is 1, then a sin-
gle 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 "EmbeddingICC Profiles in TIFF Files", avail-
able at http://www.color.org, for an explanation. SunOS 5.10 Last change: 05 Apr 2004 6 Misc. Reference Manual Pages TIFFSetField(3tiff) DiagnosticsAll error messages are directed to the TIFFError(3tiff) rou-
tine.%s: Cannot modify tag "%sD"atwahihlaes warlirteiandgy.been written to the
file, so the specified tag value cannot 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.1 is returned if the tag is defined in the current direc-
tory. Otherwise, 0 is returned.See attributes(5) for descriptions of the following attri-
butes:____________________________________________________________
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
|_____________________________|_____________________________|
| Availability | image/library/libtiff ||_____________________________|_____________________________|
| Interface stability | Uncommitted ||_____________________________|_____________________________|
libtiff(3), TIFFOpen(3tiff), TIFFGetField(3tiff), TIFFSetDirectory(3tiff), TIFFReadDirectory(3tiff), TIFFWriteDirectory(3tiff) This man page was originally written by Sam Leffler. Updated by Breda McColgan, Sun Microsystems Inc., 2004. SunOS 5.10 Last change: 05 Apr 2004 7