3
<meta name="generator" content="groff -Thtml, see www.gnu.org">
4
<meta name="Content-Style" content="text/css">
5
<title>TIFFGetField</title>
9
<h1 align=center>TIFFGetField</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="#DIAGNOSTICS">DIAGNOSTICS</a><br>
15
<a href="#SEE ALSO">SEE ALSO</a><br>
18
<!-- Creator : groff version 1.17.2 -->
19
<!-- CreationDate: Mon Dec 22 00:39:21 2003 -->
22
<table width="100%" border=0 rules="none" frame="void"
23
cols="2" cellspacing="0" cellpadding="0">
24
<tr valign="top" align="left">
25
<td width="10%"></td><td width="90%">
26
TIFFGetField, TIFFVGetField - get the value(s) of a tag in an open <small>TIFF</small> file</td></table>
27
<a name="SYNOPSIS"></a>
30
<table width="100%" border=0 rules="none" frame="void"
31
cols="2" cellspacing="0" cellpadding="0">
32
<tr valign="top" align="left">
33
<td width="10%"></td><td width="90%">
34
<b>#include <tiffio.h><br>
35
int TIFFGetField(TIFF* tif, ttag_t tag,
38
<table width="100%" border=0 rules="none" frame="void"
39
cols="2" cellspacing="0" cellpadding="0">
40
<tr valign="top" align="left">
41
<td width="10%"></td><td width="90%">
42
<b>#include <stdarg.h><br>
43
int TIFFVGetField(TIFF* tif, ttag_t tag, va_list
46
<table width="100%" border=0 rules="none" frame="void"
47
cols="2" cellspacing="0" cellpadding="0">
48
<tr valign="top" align="left">
49
<td width="10%"></td><td width="90%">
50
<b>int TIFFGetFieldDefaulted(TIFF* tif, ttag_t tag, ...)<br>
51
int TIFFVGetFieldDefaulted(TIFF* tif, ttag_t tag, va_list
53
<a name="DESCRIPTION"></a>
56
<table width="100%" border=0 rules="none" frame="void"
57
cols="2" cellspacing="0" cellpadding="0">
58
<tr valign="top" align="left">
59
<td width="10%"></td><td width="90%">
60
<i>TIFFGetField</i> returns the value of a tag or pseudo-tag
61
associated with the the current directory of the open
62
<small>TIFF</small> file <i>tif</i>. (A <i>pseudo-tag</i> is
63
a parameter that is used to control the operation of the
64
<small>TIFF</small> library but whose value is not read or
65
written to the underlying file.) The file must have been
66
previously opened with <i>TIFFOpen</i>(3T). The tag is
67
identified by <i>tag</i>, one of the values defined in the
68
include file <b>tiff.h</b> (see also the table below). The
69
type and number of values returned is dependent on the tag
70
being requested. The programming interface uses a variable
71
argument list as prescribed by the <i>stdarg</i>(3)
72
interface. The returned values should only be interpreted if
73
<i>TIFFGetField</i> returns 1.</td></table>
75
<table width="100%" border=0 rules="none" frame="void"
76
cols="2" cellspacing="0" cellpadding="0">
77
<tr valign="top" align="left">
78
<td width="10%"></td><td width="90%">
79
<i>TIFFVGetField</i> is functionally equivalent to
80
<i>TIFFGetField</i> except that it takes a pointer to a
81
variable argument list. <i>TIFFVGetField</i> is useful for
82
layering interfaces on top of the functionality provided by
83
<i>TIFFGetField</i>.</td></table>
85
<table width="100%" border=0 rules="none" frame="void"
86
cols="2" cellspacing="0" cellpadding="0">
87
<tr valign="top" align="left">
88
<td width="10%"></td><td width="90%">
89
<i>TIFFGetFieldDefaulted</i> and
90
<i>TIFFVGetFieldDefaulted</i> are identical to
91
<i>TIFFGetField</i> and <i>TIFFVGetField</i>, except that if
92
a tag is not defined in the current directory and it has a
93
default value, then the default value is
94
returned.</td></table>
96
<table width="100%" border=0 rules="none" frame="void"
97
cols="2" cellspacing="0" cellpadding="0">
98
<tr valign="top" align="left">
99
<td width="10%"></td><td width="90%">
100
The tags understood by <i>libtiff</i>, the number of
101
parameter values, and the types for the returned values are
102
shown below. The data types are specified as in C and
103
correspond to the types used to specify tag values to
104
<i>TIFFSetField</i>(3T). Remember that <i>TIFFGetField</i>
105
returns parameter values, so all the listed data types are
106
pointers to storage where values should be returned. Consult
107
the <small>TIFF</small> specification for information on the
108
meaning of each tag and their possible values.</td></table>
110
<table width="100%" border=0 rules="none" frame="void"
111
cols="2" cellspacing="0" cellpadding="0">
112
<tr valign="top" align="left">
113
<td width="10%"></td><td width="90%">
115
<i>Tag Name Count Types Notes
117
</i>TIFFTAG_ARTIST 1 char**
118
TIFFTAG_BADFAXLINES 1 uint32*
119
TIFFTAG_BITSPERSAMPLE 1 uint16*
120
TIFFTAG_CLEANFAXDATA 1 uint16*
121
TIFFTAG_COLORMAP 3 uint16** 1<<BitsPerSample arrays
122
TIFFTAG_COMPRESSION 1 uint16*
123
TIFFTAG_CONSECUTIVEBADFAXLINES 1 uint32*
124
TIFFTAG_COPYRIGHT 1 char**
125
TIFFTAG_DATATYPE 1 uint16*
126
TIFFTAG_DATETIME 1 char**
127
TIFFTAG_DOCUMENTNAME 1 char**
128
TIFFTAG_DOTRANGE 2 uint16*
129
TIFFTAG_EXTRASAMPLES 2 uint16*,uint16** count & types array
130
TIFFTAG_FAXMODE 1 int* G3/G4 compression pseudo-tag
131
TIFFTAG_FAXFILLFUNC 1 TIFFFaxFillFunc* G3/G4 compression pseudo-tag
132
TIFFTAG_FILLORDER 1 uint16*
133
TIFFTAG_GROUP3OPTIONS 1 uint32*
134
TIFFTAG_GROUP4OPTIONS 1 uint32*
135
TIFFTAG_HALFTONEHINTS 2 uint16*
136
TIFFTAG_HOSTCOMPUTER 1 char**
137
TIFFTAG_IMAGEDEPTH 1 uint32*
138
TIFFTAG_IMAGEDESCRIPTION 1 char**
139
TIFFTAG_IMAGELENGTH 1 uint32*
140
TIFFTAG_IMAGEWIDTH 1 uint32*
141
TIFFTAG_INKNAMES 1 char**
142
TIFFTAG_INKSET 1 uint16*
143
TIFFTAG_JPEGTABLES 2 u_short*,void** count & tables
144
TIFFTAG_JPEGQUALITY 1 int* JPEG pseudo-tag
145
TIFFTAG_JPEGCOLORMODE 1 int* JPEG pseudo-tag
146
TIFFTAG_JPEGTABLESMODE 1 int* JPEG pseudo-tag
147
TIFFTAG_MAKE 1 char**
148
TIFFTAG_MATTEING 1 uint16*
149
TIFFTAG_MAXSAMPLEVALUE 1 uint16*
150
TIFFTAG_MINSAMPLEVALUE 1 uint16*
151
TIFFTAG_MODEL 1 char**
152
TIFFTAG_ORIENTATION 1 uint16*
153
TIFFTAG_PAGENAME 1 char**
154
TIFFTAG_PAGENUMBER 2 uint16*
155
TIFFTAG_PHOTOMETRIC 1 uint16*
156
TIFFTAG_PLANARCONFIG 1 uint16*
157
TIFFTAG_PREDICTOR 1 uint16*
158
TIFFTAG_PRIMARYCHROMATICITIES 1 float** 6-entry array
159
TIFFTAG_REFERENCEBLACKWHITE 1 float** 2*SamplesPerPixel array
160
TIFFTAG_RESOLUTIONUNIT 1 uint16*
161
TIFFTAG_ROWSPERSTRIP 1 uint32*
162
TIFFTAG_SAMPLEFORMAT 1 uint16*
163
TIFFTAG_SAMPLESPERPIXEL 1 uint16*
164
TIFFTAG_SMAXSAMPLEVALUE 1 double*
165
TIFFTAG_SMINSAMPLEVALUE 1 double*
166
TIFFTAG_SOFTWARE 1 char**
167
TIFFTAG_STONITS 1 double**
168
TIFFTAG_STRIPBYTECOUNTS 1 uint32**
169
TIFFTAG_STRIPOFFSETS 1 uint32**
170
TIFFTAG_SUBFILETYPE 1 uint32*
171
TIFFTAG_SUBIFD 2 uint16*,uint32** count & offsets array
172
TIFFTAG_TARGETPRINTER 1 char**
173
TIFFTAG_THRESHHOLDING 1 uint16*
174
TIFFTAG_TILEBYTECOUNTS 1 uint32**
175
TIFFTAG_TILEDEPTH 1 uint32*
176
TIFFTAG_TILELENGTH 1 uint32*
177
TIFFTAG_TILEOFFSETS 1 uint32**
178
TIFFTAG_TILEWIDTH 1 uint32*
179
TIFFTAG_TRANSFERFUNCTION 1 or 3 uint16** 1<<BitsPerSample entry arrays
180
TIFFTAG_WHITEPOINT 1 float** 2-entry array
181
TIFFTAG_XPOSITION 1 float*
182
TIFFTAG_XRESOLUTION 1 float*
183
TIFFTAG_YCBCRCOEFFICIENTS 1 float** 3-entry array
184
TIFFTAG_YCBCRPOSITIONING 1 uint16*
185
TIFFTAG_YCBCRSUBSAMPLING 2 uint16*
186
TIFFTAG_YPOSITION 1 float*
187
TIFFTAG_YRESOLUTION 1 float*
188
TIFFTAG_ICCPROFILE 2 uint32*,void** count, profile data
189
</pre>If <i>SamplesPerPixel</i> is one, then a single array is returned; otherwise three arrays are returned.<br>
190
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>
191
<a name="RETURN VALUES"></a>
192
<h2>RETURN VALUES</h2>
194
<table width="100%" border=0 rules="none" frame="void"
195
cols="2" cellspacing="0" cellpadding="0">
196
<tr valign="top" align="left">
197
<td width="10%"></td><td width="90%">
198
1 is returned if the tag is defined in the current
199
directory; otherwise a 0 is returned.</td></table>
200
<a name="DIAGNOSTICS"></a>
203
<table width="100%" border=0 rules="none" frame="void"
204
cols="2" cellspacing="0" cellpadding="0">
205
<tr valign="top" align="left">
206
<td width="10%"></td><td width="90%">
207
All error messages are directed to the <i>TIFFError</i>(3T)
208
routine.</td></table>
210
<table width="100%" border=0 rules="none" frame="void"
211
cols="2" cellspacing="0" cellpadding="0">
212
<tr valign="top" align="left">
213
<td width="10%"></td><td width="90%">
214
<b>Unknown field, tag 0x%x</b>. An unknown tag was
215
supplied.</td></table>
216
<a name="SEE ALSO"></a>
219
<table width="100%" border=0 rules="none" frame="void"
220
cols="2" cellspacing="0" cellpadding="0">
221
<tr valign="top" align="left">
222
<td width="10%"></td><td width="90%">
223
<i>libtiff</i>(3T), <i>TIFFOpen</i>(3T),
224
<i>TIFFSetField</i>(3T), <i>TIFFSetDirectory</i>(3T),
225
<i>TIFFReadDirectory</i>(3T),
226
<i>TIFFWriteDirectory</i>(3T)</td></table>
added
removed
html/man/TIFFGetField.3t.html
