1
.\" $Header: /cvsroot/osrs/libtiff/man/TIFFReadDirectory.3t,v 1.1.1.1 1999/07/27 21:50:27 mike Exp $
3
.\" Copyright (c) 1988-1997 Sam Leffler
4
.\" Copyright (c) 1991-1997 Silicon Graphics, Inc.
6
.\" Permission to use, copy, modify, distribute, and sell this software and
7
.\" its documentation for any purpose is hereby granted without fee, provided
8
.\" that (i) the above copyright notices and this permission notice appear in
9
.\" all copies of the software and related documentation, and (ii) the names of
10
.\" Sam Leffler and Silicon Graphics may not be used in any advertising or
11
.\" publicity relating to the software without the specific, prior written
12
.\" permission of Sam Leffler and Silicon Graphics.
14
.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
15
.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
16
.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
18
.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
19
.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
20
.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
21
.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
22
.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
26
.TH TIFFReadDirectory 3T "October 15, 1995"
28
TIFFReadDirectory \- get the contents of the next directory in an open
32
.B "#include <tiffio.h>"
34
.B "int TIFFReadDirectory(TIFF* tif)"
36
Read the next directory in the specified file and make it the
38
Applications only need to call
40
to read multiple subfiles in a single
43
the first directory in a file is automatically read when
47
If the library is compiled with
49
enabled, then images that have a single uncompressed strip or
50
tile of data are automatically treated as if they were made
51
up of multiple strips or tiles of approximately 8 kilobytes each.
52
This operation is done only in-memory; it does not alter the
54
However, the construction of the ``chopped strips'' is visible
55
to the application through the number of strips [tiles]
59
.IR TIFFNumberOfTiles ].
61
If the next directory was successfully read, 1 is returned.
62
Otherwise, 0 is returned if an error was encountered,
63
or if there are no more directories to be read.
65
All error messages are directed to the
68
All warning messages are directed to the
72
\fBSeek error accessing TIFF directory\fP.
73
An error occurred while positioning to the location of the
76
\fBWrong data type %d for field "%s"\fP.
77
The tag entry in the directory had an incorrect data type.
84
\fBTIFF directory is missing required "%s" field\fP.
85
The specified tag is required to be present by the
87
5.0 specification, but is missing.
88
The directory is (usually) unusable.
90
\fB%s: Rational with zero denominator\fP.
93
value whose denominator is zero.
95
\fBIncorrect count %d for field "%s" (%lu, expecting %lu); tag ignored\fP.
96
The specified tag's count field is bad.
97
For example, a count other than 1 for a
101
\fBCannot handle different per-sample values for field "%s"\fP.
104
values and they are not all the same; e.g.
106
The library is unable to handle images of this sort.
108
\fBCount mismatch for field "%s"; expecting %d, got %d\fP.
110
tag does not agree with the number expected by the library.
111
This should never happen, so if it does, the library refuses to
114
\fBInvalid TIFF directory; tags are not sorted in ascending order\fP.
115
The directory tags are not properly sorted as specified
119
This error is not fatal.
121
\fBIgnoring unknown field with tag %d (0x%x)\fP.
122
An unknown tag was encountered in the directory;
123
the library ignores all such tags.
125
\fBTIFF directory is missing requred "ImageLength" field\fP.
126
The image violates the specification by not having a necessary field.
127
There is no way for the library to recover from this error.
129
\fBTIFF directory is missing requred "PlanarConfig" field\fP.
130
The image violates the specification by not having a necessary field.
131
There is no way for the library to recover from this error.
133
\fBTIFF directory is missing requred "StripOffsets" field\fP.
134
The image has multiple strips, but is missing the tag that
135
specifies the file offset to each strip of data.
136
There is no way for the library to recover from this error.
138
\fBTIFF directory is missing requred "TileOffsets" field\fP.
139
The image has multiple tiles, but is missing the tag that
140
specifies the file offset to each tile of data.
141
There is no way for the library to recover from this error.
143
\fBTIFF directory is missing required "StripByteCounts" field\fP.
144
The image has multiple strips, but is missing the tag that
145
specifies the size of each strip of data.
146
There is no way for the library to recover from this error.
148
\fBTIFF directory is missing required "StripByteCounts" field, calculating from imagelength\fP.
149
The image violates the specification by not having a necessary field.
150
However, when the image is comprised of only one strip or tile, the
151
library will estimate the missing value based on the file size.
153
\fBBogus "StripByteCounts" field, ignoring and calculating from imagelength\fP.
154
Certain vendors violate the specification by writing zero for
155
the StripByteCounts tag when they want to leave the value
157
If the image has a single strip, the library will estimate
158
the missing value based on the file size.
162
.IR TIFFWriteDirectory (3T),
163
.IR TIFFSetDirectory (3T),
164
.IR TIFFSetSubDirectory (3T)
added
removed
man/TIFFReadDirectory.3t
