3
<meta name="generator" content="groff -Thtml, see www.gnu.org">
4
<meta name="Content-Style" content="text/css">
5
<title>TIFFSetField</title>
9
<h1 align=center>TIFFSetField</h1>
10
<a href="#NAME">NAME</a><br>
11
<a href="#SYNOPSIS">SYNOPSIS</a><br>
12
<a href="#DESCRIPTION">DESCRIPTION</a><br>
13
<a href="#RETURN VALUES">RETURN VALUES</a><br>
14
<a href="#RETURN VALUES">RETURN VALUES</a><br>
15
<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
16
<a href="#SEE ALSO">SEE ALSO</a><br>
19
<!-- Creator : groff version 1.17.2 -->
20
<!-- CreationDate: Mon Dec 22 00:39:26 2003 -->
23
<table width="100%" border=0 rules="none" frame="void"
24
cols="2" cellspacing="0" cellpadding="0">
25
<tr valign="top" align="left">
26
<td width="10%"></td><td width="90%">
27
TIFFSetField - set the value(s) of a tag in a <small>TIFF</small> file open for writing</td></table>
28
<a name="SYNOPSIS"></a>
31
<table width="100%" border=0 rules="none" frame="void"
32
cols="2" cellspacing="0" cellpadding="0">
33
<tr valign="top" align="left">
34
<td width="10%"></td><td width="90%">
35
<b>#include <tiffio.h><br>
36
int TIFFSetField(TIFF* tif, ttag_t tag, ...)<br>
37
#include <stdarg.h><br>
38
int TIFFVSetField(TIFF* tif, ttag_t tag, va_list
40
<a name="DESCRIPTION"></a>
43
<table width="100%" border=0 rules="none" frame="void"
44
cols="2" cellspacing="0" cellpadding="0">
45
<tr valign="top" align="left">
46
<td width="10%"></td><td width="90%">
47
<i>TIFFSetField</i> sets the value of a field or pseudo-tag
48
in the current directory associated with the open
49
<small>TIFF</small> file <i>tif</i>. (A <i>pseudo-tag</i> is
50
a parameter that is used to control the operation of the
51
<small>TIFF</small> library but whose value is not read or
52
written to the underlying file.) To set the value of a field
53
the file must have been previously opened for writing with
54
<i>TIFFOpen</i>(3T); pseudo-tags can be set whether the file
55
was opened for reading or writing. The field is identified
56
by <i>tag</i>, one of the values defined in the include file
57
<b>tiff.h</b> (see also the table below). The actual value
58
is specified using a variable argument list, as prescribed
59
by the <i>stdarg</i>(3) interface (or, on some machines, the
60
<i>varargs</i>(3) interface.)</td></table>
62
<table width="100%" border=0 rules="none" frame="void"
63
cols="2" cellspacing="0" cellpadding="0">
64
<tr valign="top" align="left">
65
<td width="10%"></td><td width="90%">
66
<i>TIFFVSetField</i> is functionally equivalent to
67
<i>TIFFSetField</i> except that it takes a pointer to a
68
variable argument list. <i>TIFFVSetField</i> is useful for
69
writing routines that are layered on top of the
70
functionality provided by <i>TIFFSetField</i>.</td></table>
72
<table width="100%" border=0 rules="none" frame="void"
73
cols="2" cellspacing="0" cellpadding="0">
74
<tr valign="top" align="left">
75
<td width="10%"></td><td width="90%">
76
The tags understood by <i>libtiff</i>, the number of
77
parameter values, and the expected types for the parameter
78
values are shown below. The data types are: <i>char*</i> is
79
null-terminated string and corresponds to the
80
<small>ASCII</small> data type; <i>uint16</i> is an unsigned
81
16-bit value; <i>uint32</i> is an unsigned 32-bit value;
82
<i>uint16*</i> is an array of unsigned 16-bit values.
83
<i>void*</i> is an array of data values of unspecified
86
<table width="100%" border=0 rules="none" frame="void"
87
cols="2" cellspacing="0" cellpadding="0">
88
<tr valign="top" align="left">
89
<td width="10%"></td><td width="90%">
90
Consult the <small>TIFF</small> specification for
91
information on the meaning of each tag.</td></table>
93
<table width="100%" border=0 rules="none" frame="void"
94
cols="2" cellspacing="0" cellpadding="0">
95
<tr valign="top" align="left">
96
<td width="10%"></td><td width="90%">
98
<i>Tag Name Count Types Notes
100
</i>TIFFTAG_ARTIST 1 char*
101
TIFFTAG_BADFAXLINES 1 uint32
102
TIFFTAG_BITSPERSAMPLE 1 uint16
103
TIFFTAG_CLEANFAXDATA 1 uint16
104
TIFFTAG_COLORMAP 3 uint16* 1<<BitsPerSample arrays
105
TIFFTAG_COMPRESSION 1 uint16
106
TIFFTAG_CONSECUTIVEBADFAXLINES 1 uint32
107
TIFFTAG_COPYRIGHT 1 char*
108
TIFFTAG_DATETIME 1 char*
109
TIFFTAG_DOCUMENTNAME 1 char*
110
TIFFTAG_DOTRANGE 2 uint16
111
TIFFTAG_EXTRASAMPLES 2 uint16,uint16* count & types array
112
TIFFTAG_FAXMODE 1 int G3/G4 compression pseudo-tag
113
TIFFTAG_FAXFILLFUNC 1 TIFFFaxFillFunc G3/G4 compression pseudo-tag
114
TIFFTAG_FILLORDER 1 uint16
115
TIFFTAG_GROUP3OPTIONS 1 uint32
116
TIFFTAG_GROUP4OPTIONS 1 uint32
117
TIFFTAG_HALFTONEHINTS 2 uint16
118
TIFFTAG_HOSTCOMPUTER 1 char*
119
TIFFTAG_IMAGEDESCRIPTION 1 char*
120
TIFFTAG_IMAGEDEPTH 1 uint32
121
TIFFTAG_IMAGELENGTH 1 uint32
122
TIFFTAG_IMAGEWIDTH 1 uint32
123
TIFFTAG_INKNAMES 1 char*
124
TIFFTAG_INKSET 1 uint16
125
TIFFTAG_JPEGTABLES 2 uint32*,void* count & tables
126
TIFFTAG_JPEGQUALITY 1 int JPEG pseudo-tag
127
TIFFTAG_JPEGCOLORMODE 1 int JPEG pseudo-tag
128
TIFFTAG_JPEGTABLESMODE 1 int JPEG pseudo-tag
130
TIFFTAG_MATTEING 1 uint16
131
TIFFTAG_MAXSAMPLEVALUE 1 uint16
132
TIFFTAG_MINSAMPLEVALUE 1 uint16
133
TIFFTAG_MODEL 1 char*
134
TIFFTAG_ORIENTATION 1 uint16
135
TIFFTAG_PAGENAME 1 char*
136
TIFFTAG_PAGENUMBER 2 uint16
137
TIFFTAG_PHOTOMETRIC 1 uint16
138
TIFFTAG_PLANARCONFIG 1 uint16
139
TIFFTAG_PREDICTOR 1 uint16
140
TIFFTAG_PRIMARYCHROMATICITIES 1 float* 6-entry array
141
TIFFTAG_REFERENCEBLACKWHITE 1 float* 2*SamplesPerPixel array
142
TIFFTAG_RESOLUTIONUNIT 1 uint16
143
TIFFTAG_ROWSPERSTRIP 1 uint32 must be > 0
144
TIFFTAG_SAMPLEFORMAT 1 uint16
145
TIFFTAG_SAMPLESPERPIXEL 1 uint16 value must be <= 4
146
TIFFTAG_SMAXSAMPLEVALUE 1 double
147
TIFFTAG_SMINSAMPLEVALUE 1 double
148
TIFFTAG_SOFTWARE 1 char*
149
TIFFTAG_STONITS 1 double
150
TIFFTAG_SUBFILETYPE 1 uint32
151
TIFFTAG_SUBIFD 2 uint16,uint32* count & offsets array
152
TIFFTAG_TARGETPRINTER 1 char*
153
TIFFTAG_THRESHHOLDING 1 uint16
154
TIFFTAG_TILEDEPTH 1 uint32
155
TIFFTAG_TILELENGTH 1 uint32 must be a multiple of 8
156
TIFFTAG_TILEWIDTH 1 uint32 must be a multiple of 8
157
TIFFTAG_TRANSFERFUNCTION 1 or 3 uint16* 1<<BitsPerSample entry arrays
158
TIFFTAG_XPOSITION 1 float
159
TIFFTAG_XRESOLUTION 1 float
160
TIFFTAG_WHITEPOINT 1 float* 2-entry array
161
TIFFTAG_YCBCRCOEFFICIENTS 1 float* 3-entry array
162
TIFFTAG_YCBCRPOSITIONING 1 uint16
163
TIFFTAG_YCBCRSAMPLING 2 uint16
164
TIFFTAG_YPOSITION 1 float
165
TIFFTAG_YRESOLUTION 1 float
166
TIFFTAG_ICCPROFILE 2 uint32,void* count, profile data*
167
</pre>Tag may not have its values changed once data is written.<br>
168
If <i>SamplesPerPixel</i> is one, then a single array is passed; otherwise three arrays should be passed.<br>
169
* The contents of this field are quite complex. See <i>The ICC Profile Format Specification</i>, Annex B.3 "Embedding ICC Profiles in TIFF Files" (available at http://www.color.org) for an explanation.</td></table>
170
<a name="RETURN VALUES"></a>
171
<h2>RETURN VALUES</h2>
173
<table width="100%" border=0 rules="none" frame="void"
174
cols="2" cellspacing="0" cellpadding="0">
175
<tr valign="top" align="left">
176
<td width="10%"></td><td width="90%">
177
1 is returned if the tag is defined in the current
178
directory; otherwise a 0 is returned.</td></table>
179
<a name="RETURN VALUES"></a>
180
<h2>RETURN VALUES</h2>
182
<table width="100%" border=0 rules="none" frame="void"
183
cols="2" cellspacing="0" cellpadding="0">
184
<tr valign="top" align="left">
185
<td width="10%"></td><td width="90%">
186
1 is returned if the operation was successful. Otherwise, 0
187
is returned if an error was detected.</td></table>
188
<a name="DIAGNOSTICS"></a>
191
<table width="100%" border=0 rules="none" frame="void"
192
cols="2" cellspacing="0" cellpadding="0">
193
<tr valign="top" align="left">
194
<td width="10%"></td><td width="90%">
195
All error messages are directed to the <i>TIFFError</i>(3T)
196
routine.</td></table>
198
<table width="100%" border=0 rules="none" frame="void"
199
cols="2" cellspacing="0" cellpadding="0">
200
<tr valign="top" align="left">
201
<td width="10%"></td><td width="90%">
202
<b>%s: Cannot modify tag "%s" while writing</b>.
203
Data has already been written to the file, so the specified
204
tag's value can not be changed. This restriction is applied
205
to all tags that affect the format of written
208
<table width="100%" border=0 rules="none" frame="void"
209
cols="2" cellspacing="0" cellpadding="0">
210
<tr valign="top" align="left">
211
<td width="10%"></td><td width="90%">
212
<b>%d: Bad value for "%s"</b>. An invalid value
213
was supplied for the named tag.</td></table>
214
<a name="SEE ALSO"></a>
217
<table width="100%" border=0 rules="none" frame="void"
218
cols="2" cellspacing="0" cellpadding="0">
219
<tr valign="top" align="left">
220
<td width="10%"></td><td width="90%">
221
<i>libtiff</i>(3T), <i>TIFFOpen</i>(3T),
222
<i>TIFFGetField</i>(3T), <i>TIFFSetDirectory</i>(3T),
223
<i>TIFFWriteDirectory</i>(3T),
224
<i>TIFFReadDirectory</i>(3T)</td></table>
added
removed
html/man/TIFFSetField.3t.html
