TIFFSetDirectory.3tiff revision 10139
0N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
3153N/A<!--ArborText, Inc., 1988-1999, v.4002-->
0N/A<!ENTITY synp-tt "SYNOPSIS">
0N/A<!ENTITY cmd "TIFFSetDirectory">
0N/A<!ENTITY % commonents SYSTEM "smancommon.ent">
0N/A%commonents;
0N/A<!ENTITY % gnomecommonents SYSTEM "gnomecommon.ent">
0N/A%gnomecommonents;
0N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">
0N/A%booktitles;
0N/A<!ENTITY suncopy "Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.">
0N/A]>
0N/A<?Pub UDT _bookmark _target>
0N/A<?Pub Inc>
0N/A<?PubInc>
0N/A<refentry id="TIFFSetDirectory-3tiff">
0N/A<!-- %Z%%M% %I% %E% SMI; -->
0N/A<refmeta><refentrytitle>TIFFSetDirectory</refentrytitle><manvolnum>3tiff</manvolnum>
1472N/A<refmiscinfo class="date">05 Apr 2004</refmiscinfo>
1472N/A<refmiscinfo class="sectdesc">&man3;</refmiscinfo>
1472N/A<refmiscinfo class="software">&release;</refmiscinfo>
0N/A<refmiscinfo class="arch">generic</refmiscinfo>
0N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
0N/A</refmeta>
1879N/A<indexterm><primary>TIFFSetDirectory</primary></indexterm><indexterm><primary>
1879N/Aset the current directory for an open TIFF file</primary></indexterm>
1879N/A<refnamediv id="TIFFSetDirectory-3tiff-name"><refname>TIFFSetDirectory</refname>
1879N/A<refname>TIFFSetSubDirectory</refname><refpurpose>set the current directory
3153N/Afor an open TIFF file</refpurpose></refnamediv>
3153N/A<refsect1 id="TIFFSetDirectory-3tiff-synp"><title>&synp-tt;</title>
3153N/A<programlisting>#include &lt;tiffio.h>
3153N/Aint TIFFSetDirectory(TIFF* tif, tdir_t dirnum)
3153N/Aint TIFFSetSubDirectory(TIFF* tif, uint32 diroff)</programlisting>
3153N/A</refsect1>
3153N/A<refsect1 id="TIFFSetDirectory-3tiff-desc"><title>&desc-tt;</title>
3153N/A<para><literal>TIFFSetDirectory</literal> changes the current directory and
3153N/Areads the directory contents with <literal>TIFFReadDirectory</literal>. The
3153N/Aparameter <literal>dirnum</literal> specifies the subfile/directory as an
3153N/Ainteger number, with the first directory numbered zero.</para>
1879N/A<para><literal>TIFFSetSubDirectory</literal> acts like <literal>TIFFSetDirectory
1879N/A</literal>, except that the directory is specified as a file offset instead
1879N/Aof an index. This is required for accessing subdirectories linked through
1879N/Aa <literal>SubIFD</literal> tag.</para>
1879N/A</refsect1>
1879N/A<refsect1 id="TIFFSetDirectory-3tiff-exde"><title>&exde-tt;</title>
1879N/A<refsect2 id="TIFFSetDirectory-3tiff-exde-diags">
1879N/A<title>Diagnostics</title>
1879N/A<para>All error messages are directed to the <literal>TIFFError(3tiff)</literal>
2073N/Aroutine.</para>
2073N/A<variablelist>
2073N/A<varlistentry><term>%s: Error fetching directory count.</term><listitem><para>
2073N/AAn error was encountered while reading the &ldquo;directory count&rdquo; field.
2073N/A</para>
2073N/A</listitem></varlistentry>
1879N/A<varlistentry><term>%s: Error fetching directory link.</term><listitem><para>
1879N/AAn error was encountered while reading the &ldquo;link value&rdquo; that points
1879N/Ato the next directory in a file.</para>
1879N/A</listitem></varlistentry>
1879N/A</variablelist></refsect2>
1879N/A</refsect1>
1879N/A<refsect1 id="TIFFSetDirectory-3tiff-rtrn"><title>&rtrn-tt;</title>
1879N/A<para>On successful completion, 1 is returned. Otherwise, 0 is returned if <literal>
1879N/Adirnum</literal> or <literal>diroff</literal> specifies a non-existent directory,
2796N/Aor if an error was encountered while reading the directory contents.</para>
2796N/A</refsect1>
2796N/A<refsect1 id="TIFFSetDirectory-3tiff-attr"><title>&attr-tt;</title>
1879N/A<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
1879N/A<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
1879N/Afor descriptions of the following attributes:</para>
1879N/A<informaltable frame="all">
1879N/A<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
1879N/A<colspec colname="COLSPEC1" colwidth="1*">
1879N/A<thead>
1879N/A<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
1879N/Avalign="middle">ATTRIBUTE VALUE</entry></row>
1879N/A</thead>
1879N/A<tbody>
1879N/A<row><entry><para>Availability</para></entry><entry><para>SUNWTiff</para></entry>
1879N/A</row>
1879N/A<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
1879N/Acolname="COLSPEC1"><para>Evolving</para></entry></row>
1879N/A</tbody>
1879N/A</tgroup>
1879N/A</informaltable>
2073N/A</refsect1>
2073N/A<refsect1 id="TIFFSetDirectory-3tiff-also"><title>&also-tt;</title>
2073N/A<!--Reference to another man page-->
2073N/A<!--Reference to a Help manual-->
2073N/A<!--Reference to a book.-->
2073N/A<para><citerefentry><refentrytitle>libtiff</refentrytitle><manvolnum>3</manvolnum>
2796N/A</citerefentry>, <citerefentry><refentrytitle>TIFFCurrent<?Pub Caret>Directory
2796N/A</refentrytitle><manvolnum>3tiff</manvolnum></citerefentry>, <citerefentry>
2796N/A<refentrytitle>TIFFOpen</refentrytitle><manvolnum>3tiff</manvolnum></citerefentry>, <citerefentry>
2796N/A<refentrytitle>TIFFReadDirectory</refentrytitle><manvolnum>3tiff</manvolnum>
2796N/A</citerefentry>, <citerefentry><refentrytitle>TIFFWriteDirectory</refentrytitle>
2796N/A<manvolnum>3tiff</manvolnum></citerefentry></para>
1879N/A</refsect1>
1879N/A<refsect1 id="TIFFSetDirectory-3tiff-note"><title>&note-tt;</title>
1879N/A<para>This man page was originally written by Sam Leffler. Updated by Breda
1879N/AMcColgan, Sun Microsystems Inc., 2004.</para>
1879N/A</refsect1>
1879N/A</refentry>
1879N/A<?Pub *0000005044>
2073N/A