Current Directory: /usr/share/doc/libtiff-devel/html/man
Viewing File: /usr/share/doc/libtiff-devel/html/man/TIFFSetDirectory.3tiff.html
<!-- Creator : groff version 1.22.4 -->
<!-- CreationDate: Sun Nov 2 19:00:00 2025 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
p { margin-top: 0; margin-bottom: 0; vertical-align: top }
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
h1 { text-align: center }
</style>
<title>TIFFSetDirectory</title>
</head>
<body>
<h1 align="center">TIFFSetDirectory</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</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>
<h2>NAME
<a name="NAME"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">TIFFSetDirectory,
TIFFSetSubDirectory − set the current directory for an
open <small>TIFF</small> file</p>
<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>#include
<tiffio.h></b></p>
<p style="margin-left:11%; margin-top: 1em"><b>int
TIFFSetDirectory(TIFF *</b><i>tif</i><b>, tdir_t</b>
<i>dirnum</i><b>) <br>
int TIFFSetSubDirectory(TIFF *</b><i>tif</i><b>,
uint64_t</b> <i>diroff</i><b>)</b></p>
<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b><i>TIFFSetDirectory</i></b>
changes the current directory and reads its contents with
<i>TIFFReadDirectory</i>. The parameter <i>dirnum</i>
specifies the subfile/directory as an integer number, with
the first directory numbered zero.</p>
<p style="margin-left:11%; margin-top: 1em"><i>TIFFSetSubDirectory</i>
acts like <i>TIFFSetDirectory</i>, except the directory is
specified as a file offset instead of an index; this is
required for accessing subdirectories linked through a
<i>SubIFD</i> tag.</p>
<h2>RETURN VALUES
<a name="RETURN VALUES"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">On successful
return 1 is returned. Otherwise, 0 is returned if
<i>dirnum</i> or <i>diroff</i> specifies a non-existent
directory, or if an error was encountered while reading the
directory’s contents.</p>
<h2>DIAGNOSTICS
<a name="DIAGNOSTICS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">All error
messages are directed to the <i>TIFFError</i>(3TIFF)
routine.</p>
<p style="margin-left:11%; margin-top: 1em"><b>%s: Error
fetching directory count</b>. An error was encountered while
reading the ‘‘directory count’’
field.</p>
<p style="margin-left:11%; margin-top: 1em"><b>%s: Error
fetching directory link</b>. An error was encountered while
reading the ‘‘link value’’ that
points to the next directory in a file.</p>
<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><i>TIFFCurrentDirectory</i>(3TIFF),
<i>TIFFOpen</i>(3TIFF), <i>TIFFReadDirectory</i>(3TIFF),
<i>TIFFWriteDirectory</i>(3TIFF), <i>libtiff</i>(3TIFF)</p>
<p style="margin-left:11%; margin-top: 1em">Libtiff library
home page: <b>http://www.simplesystems.org/libtiff/</b></p>
<hr>
</body>
</html>