2002-10-07 09:47:36 -04:00
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta name="generator" content="groff -Thtml, see www.gnu.org">
|
|
|
|
|
<meta name="Content-Style" content="text/css">
|
|
|
|
|
<title>TIFFReadDirectory</title>
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<h1 align=center>TIFFReadDirectory</h1>
|
|
|
|
|
<a href="#NAME">NAME</a><br>
|
|
|
|
|
<a href="#SYNOPSIS">SYNOPSIS</a><br>
|
|
|
|
|
<a href="#DESCRIPTION">DESCRIPTION</a><br>
|
|
|
|
|
<a href="#NOTES">NOTES</a><br>
|
|
|
|
|
<a href="#RETURN VALUES">RETURN VALUES</a><br>
|
|
|
|
|
<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
|
|
|
|
|
<a href="#SEE ALSO">SEE ALSO</a><br>
|
|
|
|
|
|
|
|
|
|
<hr>
|
2003-11-27 10:07:01 -05:00
|
|
|
<!-- Creator : groff version 1.17.2 -->
|
2003-12-21 16:47:11 -05:00
|
|
|
<!-- CreationDate: Mon Dec 22 00:39:23 2003 -->
|
2002-10-07 09:47:36 -04:00
|
|
|
<a name="NAME"></a>
|
|
|
|
|
<h2>NAME</h2>
|
2003-11-27 10:07:01 -05:00
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
2002-10-07 09:47:36 -04:00
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
2003-11-27 10:07:01 -05:00
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
TIFFReadDirectory - get the contents of the next directory in an open <small>TIFF</small> file</td></table>
|
2002-10-07 09:47:36 -04:00
|
|
|
<a name="SYNOPSIS"></a>
|
|
|
|
|
<h2>SYNOPSIS</h2>
|
2003-11-27 10:07:01 -05:00
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
2002-10-07 09:47:36 -04:00
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
2003-11-27 10:07:01 -05:00
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<b>#include <tiffio.h><br>
|
|
|
|
|
int TIFFReadDirectory(TIFF* tif)</b></td></table>
|
2002-10-07 09:47:36 -04:00
|
|
|
<a name="DESCRIPTION"></a>
|
|
|
|
|
<h2>DESCRIPTION</h2>
|
2003-11-27 10:07:01 -05:00
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
2002-10-07 09:47:36 -04:00
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
2003-11-27 10:07:01 -05:00
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
Read the next directory in the specified file and make it
|
|
|
|
|
the current directory. Applications only need to call
|
|
|
|
|
<i>TIFFReadDirectory</i> to read multiple subfiles in a
|
|
|
|
|
single <small>TIFF</small> file-- the first directory in a
|
2002-10-07 09:47:36 -04:00
|
|
|
file is automatically read when <i>TIFFOpen</i> is
|
2003-11-27 10:07:01 -05:00
|
|
|
called.</td></table>
|
2002-10-07 09:47:36 -04:00
|
|
|
<a name="NOTES"></a>
|
|
|
|
|
<h2>NOTES</h2>
|
2003-11-27 10:07:01 -05:00
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
If the library is compiled with
|
|
|
|
|
<small>STRIPCHOP_SUPPORT</small> enabled, then images that
|
|
|
|
|
have a single uncompressed strip or tile of data are
|
|
|
|
|
automatically treated as if they were made up of multiple
|
|
|
|
|
strips or tiles of approximately 8 kilobytes each. This
|
|
|
|
|
operation is done only in-memory; it does not alter the
|
|
|
|
|
contents of the file. However, the construction of the
|
|
|
|
|
``chopped strips'' is visible to the application through the
|
|
|
|
|
number of strips [tiles] returned by
|
2002-10-07 09:47:36 -04:00
|
|
|
<i>TIFFNumberOfStrips</i>
|
2003-11-27 10:07:01 -05:00
|
|
|
[<i>TIFFNumberOfTiles</i>].</td></table>
|
2002-10-07 09:47:36 -04:00
|
|
|
<a name="RETURN VALUES"></a>
|
|
|
|
|
<h2>RETURN VALUES</h2>
|
2003-11-27 10:07:01 -05:00
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
If the next directory was successfully read, 1 is returned.
|
|
|
|
|
Otherwise, 0 is returned if an error was encountered, or if
|
|
|
|
|
there are no more directories to be read.</td></table>
|
2002-10-07 09:47:36 -04:00
|
|
|
<a name="DIAGNOSTICS"></a>
|
|
|
|
|
<h2>DIAGNOSTICS</h2>
|
2003-11-27 10:07:01 -05:00
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
All error messages are directed to the <i>TIFFError</i>(3T)
|
|
|
|
|
routine. All warning messages are directed to the
|
|
|
|
|
<i>TIFFWarning</i>(3T) routine.</td></table>
|
|
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
2002-10-07 09:47:36 -04:00
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
2003-11-27 10:07:01 -05:00
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<b>Seek error accessing TIFF directory</b>. An error
|
2002-10-07 09:47:36 -04:00
|
|
|
occurred while positioning to the location of the
|
2003-11-27 10:07:01 -05:00
|
|
|
directory.</td></table>
|
|
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<b>Wrong data type %d for field "%s"</b>. The tag
|
|
|
|
|
entry in the directory had an incorrect data type. For
|
|
|
|
|
example, an <i>ImageDescription</i> tag with a
|
|
|
|
|
<small>SHORT</small> data type.</td></table>
|
|
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<b>TIFF directory is missing required "%s"
|
2002-10-07 09:47:36 -04:00
|
|
|
field</b>. The specified tag is required to be present by
|
2003-11-27 10:07:01 -05:00
|
|
|
the <small>TIFF</small> 5.0 specification, but is missing.
|
|
|
|
|
The directory is (usually) unusable.</td></table>
|
|
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<b>%s: Rational with zero denominator</b>. A directory tag
|
|
|
|
|
has a <small>RATIONAL</small> value whose denominator is
|
|
|
|
|
zero.</td></table>
|
|
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<b>Incorrect count %d for field "%s" (%lu,
|
|
|
|
|
expecting %lu); tag ignored</b>. The specified tag's count
|
|
|
|
|
field is bad. For example, a count other than 1 for a
|
|
|
|
|
<i>SubFileType</i> tag.</td></table>
|
|
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<b>Cannot handle different per-sample values for field
|
|
|
|
|
"%s"</b>. The tag has <i>SamplesPerPixel</i>
|
1999-11-22 23:29:23 -05:00
|
|
|
values and they are not all the same; e.g.
|
2002-10-07 09:47:36 -04:00
|
|
|
<i>BitsPerSample</i>. The library is unable to handle images
|
2003-11-27 10:07:01 -05:00
|
|
|
of this sort.</td></table>
|
|
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<b>Count mismatch for field "%s"; expecting %d,
|
|
|
|
|
got %d</b>. The count field in a tag does not agree with the
|
|
|
|
|
number expected by the library. This should never happen, so
|
|
|
|
|
if it does, the library refuses to read the
|
|
|
|
|
directory.</td></table>
|
|
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<b>Invalid TIFF directory; tags are not sorted in ascending
|
|
|
|
|
order</b>. The directory tags are not properly sorted as
|
|
|
|
|
specified in the <small>TIFF</small> 5.0 specification. This
|
|
|
|
|
error is not fatal.</td></table>
|
|
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<b>Ignoring unknown field with tag %d (0x%x)</b>. An unknown
|
|
|
|
|
tag was encountered in the directory; the library ignores
|
|
|
|
|
all such tags.</td></table>
|
|
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<b>TIFF directory is missing requred "ImageLength"
|
|
|
|
|
field</b>. The image violates the specification by not
|
|
|
|
|
having a necessary field. There is no way for the library to
|
|
|
|
|
recover from this error.</td></table>
|
|
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<b>TIFF directory is missing requred
|
2002-10-07 09:47:36 -04:00
|
|
|
"PlanarConfig" field</b>. The image violates the
|
|
|
|
|
specification by not having a necessary field. There is no
|
2003-11-27 10:07:01 -05:00
|
|
|
way for the library to recover from this error.</td></table>
|
|
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<b>TIFF directory is missing requred
|
2002-10-07 09:47:36 -04:00
|
|
|
"StripOffsets" field</b>. The image has multiple
|
|
|
|
|
strips, but is missing the tag that specifies the file
|
|
|
|
|
offset to each strip of data. There is no way for the
|
2003-11-27 10:07:01 -05:00
|
|
|
library to recover from this error.</td></table>
|
|
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<b>TIFF directory is missing requred "TileOffsets"
|
|
|
|
|
field</b>. The image has multiple tiles, but is missing the
|
|
|
|
|
tag that specifies the file offset to each tile of data.
|
|
|
|
|
There is no way for the library to recover from this
|
|
|
|
|
error.</td></table>
|
|
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<b>TIFF directory is missing required
|
2002-10-07 09:47:36 -04:00
|
|
|
"StripByteCounts" field</b>. The image has
|
|
|
|
|
multiple strips, but is missing the tag that specifies the
|
|
|
|
|
size of each strip of data. There is no way for the library
|
2003-11-27 10:07:01 -05:00
|
|
|
to recover from this error.</td></table>
|
|
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<b>TIFF directory is missing required
|
2002-10-07 09:47:36 -04:00
|
|
|
"StripByteCounts" field, calculating from
|
|
|
|
|
imagelength</b>. The image violates the specification by not
|
|
|
|
|
having a necessary field. However, when the image is
|
|
|
|
|
comprised of only one strip or tile, the library will
|
2003-11-27 10:07:01 -05:00
|
|
|
estimate the missing value based on the file
|
|
|
|
|
size.</td></table>
|
|
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
|
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<b>Bogus "StripByteCounts" field, ignoring and
|
|
|
|
|
calculating from imagelength</b>. Certain vendors violate
|
|
|
|
|
the specification by writing zero for the StripByteCounts
|
|
|
|
|
tag when they want to leave the value unspecified. If the
|
|
|
|
|
image has a single strip, the library will estimate the
|
|
|
|
|
missing value based on the file size.</td></table>
|
2002-10-07 09:47:36 -04:00
|
|
|
<a name="SEE ALSO"></a>
|
|
|
|
|
<h2>SEE ALSO</h2>
|
2003-11-27 10:07:01 -05:00
|
|
|
|
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
2002-10-07 09:47:36 -04:00
|
|
|
cols="2" cellspacing="0" cellpadding="0">
|
|
|
|
|
<tr valign="top" align="left">
|
2003-11-27 10:07:01 -05:00
|
|
|
<td width="10%"></td><td width="90%">
|
|
|
|
|
<i>libtiff</i>(3T), <i>TIFFOpen</i>(3T),
|
2002-10-07 09:47:36 -04:00
|
|
|
<i>TIFFWriteDirectory</i>(3T), <i>TIFFSetDirectory</i>(3T),
|
2003-11-27 10:07:01 -05:00
|
|
|
<i>TIFFSetSubDirectory</i>(3T)</td></table>
|
2002-10-07 09:47:36 -04:00
|
|
|
<hr>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
