libtiff/html/man/TIFFSetDirectory.3t.html
1999-11-23 04:29:23 +00:00

115 lines
2.7 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML><HEAD><TITLE>Manpage of TIFFSetDirectory</TITLE>
</HEAD><BODY BGCOLOR=WHITE><FONT FACE="helvetica, sans, arial">
<H1>TIFFSetDirectory</H1>
Section: Misc. Reference Manual Pages (3T)<BR>Updated: October 15, 1995<BR><A HREF="#index">Index</A>
<BR><A HREF="index.html">Return to Main Contents</A>
<HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
TIFFSetDirectory, TIFFSetSubDirectory - set the current directory for an open
<FONT SIZE="-1">TIFF</FONT>
file
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>#include &lt;<A HREF="file:/usr/include/tiffio.h">tiffio.h</A>&gt;</B>
<BR>
<B>int TIFFSetDirectory(TIFF* tif, tdir_t dirnum)</B>
<BR>
<B>int TIFFSetSubDirectory(TIFF* tif, uint32 diroff)</B>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<I>TIFFSetDirectory</I>
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>
<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.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUES</H2>
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.
<A NAME="lbAF">&nbsp;</A>
<H2>DIAGNOSTICS</H2>
All error messages are directed to the
<I><A HREF="TIFFError.3t.html">TIFFError</A></I>(3T)
routine.
<P>
<B>%s: Error fetching directory count</B>.
An error was encountered while reading the ``directory count'' field.
<P>
<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.
<A NAME="lbAG">&nbsp;</A>
<H2>SEE ALSO</H2>
<I><A HREF="libtiff.3t.html">libtiff</A></I>(3T),
<I><A HREF="TIFFCurrentDirectory.3t.html">TIFFCurrentDirectory</A></I>(3T),
<I><A HREF="TIFFOpen.3t.html">TIFFOpen</A></I>(3T),
<I><A HREF="TIFFReadDirectory.3t.html">TIFFReadDirectory</A></I>(3T),
<I><A HREF="TIFFWriteDirectory.3t.html">TIFFWriteDirectory</A></I>(3T)
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">RETURN VALUES</A><DD>
<DT><A HREF="#lbAF">DIAGNOSTICS</A><DD>
<DT><A HREF="#lbAG">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="index.html">man2html</A>,
using the manual pages.<BR>
Time: 01:31:38 GMT, November 23, 1999
</BODY>
</HTML>