]> git.saurik.com Git - wxWidgets.git/blame - src/tiff/html/man/TIFFSetDirectory.3tiff.html
fix wxGTK1 compilation after wxTextEntry DoGetValue() change
[wxWidgets.git] / src / tiff / html / man / TIFFSetDirectory.3tiff.html
CommitLineData
8414a40c
VZ
1<!-- Creator : groff version 1.18.1 -->
2<!-- CreationDate: Mon Mar 13 18:03:10 2006 -->
3<html>
4<head>
5<meta name="generator" content="groff -Thtml, see www.gnu.org">
6<meta name="Content-Style" content="text/css">
7<title>TIFFSetDirectory</title>
8</head>
9<body>
10
11<h1 align=center>TIFFSetDirectory</h1>
12<a href="#NAME">NAME</a><br>
13<a href="#SYNOPSIS">SYNOPSIS</a><br>
14<a href="#DESCRIPTION">DESCRIPTION</a><br>
15<a href="#RETURN VALUES">RETURN VALUES</a><br>
16<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
17<a href="#SEE ALSO">SEE ALSO</a><br>
18
19<hr>
20<a name="NAME"></a>
21<h2>NAME</h2>
22<!-- INDENTATION -->
23<table width="100%" border=0 rules="none" frame="void"
24 cols="2" cellspacing="0" cellpadding="0">
25<tr valign="top" align="left">
26<td width="8%"></td>
27<td width="91%">
28<p>TIFFSetDirectory, TIFFSetSubDirectory &minus; set the
29current directory for an open <small>TIFF</small> file</p>
30</td>
31</table>
32<a name="SYNOPSIS"></a>
33<h2>SYNOPSIS</h2>
34<!-- INDENTATION -->
35<table width="100%" border=0 rules="none" frame="void"
36 cols="2" cellspacing="0" cellpadding="0">
37<tr valign="top" align="left">
38<td width="8%"></td>
39<td width="91%">
40<p><b>#include &lt;tiffio.h&gt;</b></p>
41<!-- INDENTATION -->
42<p><b>int TIFFSetDirectory(TIFF *</b><i>tif</i><b>,
43tdir_t</b> <i>dirnum</i><b>)<br>
44int TIFFSetSubDirectory(TIFF *</b><i>tif</i><b>, uint32</b>
45<i>diroff</i><b>)</b></p>
46</td>
47</table>
48<a name="DESCRIPTION"></a>
49<h2>DESCRIPTION</h2>
50<!-- INDENTATION -->
51<table width="100%" border=0 rules="none" frame="void"
52 cols="2" cellspacing="0" cellpadding="0">
53<tr valign="top" align="left">
54<td width="8%"></td>
55<td width="91%">
56<p><i>TIFFSetDirectory</i> changes the current directory and
57reads its contents with <i>TIFFReadDirectory</i>. The
58parameter <i>dirnum</i> specifies the subfile/directory as
59an integer number, with the first directory numbered
60zero.</p>
61<!-- INDENTATION -->
62<p><i>TIFFSetSubDirectory</i> acts like
63<i>TIFFSetDirectory</i>, except the directory is specified
64as a file offset instead of an index; this is required for
65accessing subdirectories linked through a <i>SubIFD</i>
66tag.</p>
67</td>
68</table>
69<a name="RETURN VALUES"></a>
70<h2>RETURN VALUES</h2>
71<!-- INDENTATION -->
72<table width="100%" border=0 rules="none" frame="void"
73 cols="2" cellspacing="0" cellpadding="0">
74<tr valign="top" align="left">
75<td width="8%"></td>
76<td width="91%">
77<p>On successful return 1 is returned. Otherwise, 0 is
78returned if <i>dirnum</i> or <i>diroff</i> specifies a
79non-existent directory, or if an error was encountered while
80reading the directory&rsquo;s contents.</p>
81</td>
82</table>
83<a name="DIAGNOSTICS"></a>
84<h2>DIAGNOSTICS</h2>
85<!-- INDENTATION -->
86<table width="100%" border=0 rules="none" frame="void"
87 cols="2" cellspacing="0" cellpadding="0">
88<tr valign="top" align="left">
89<td width="8%"></td>
90<td width="91%">
91<p>All error messages are directed to the
92<i>TIFFError</i>(3TIFF) routine.</p>
93<!-- INDENTATION -->
94<p><b>%s: Error fetching directory count</b>. An error was
95encountered while reading the &lsquo;&lsquo;directory
96count&rsquo;&rsquo; field.</p>
97<!-- INDENTATION -->
98<p><b>%s: Error fetching directory link</b>. An error was
99encountered while reading the &lsquo;&lsquo;link
100value&rsquo;&rsquo; that points to the next directory in a
101file.</p>
102</td>
103</table>
104<a name="SEE ALSO"></a>
105<h2>SEE ALSO</h2>
106<!-- INDENTATION -->
107<table width="100%" border=0 rules="none" frame="void"
108 cols="2" cellspacing="0" cellpadding="0">
109<tr valign="top" align="left">
110<td width="8%"></td>
111<td width="91%">
112<p><i>TIFFCurrentDirectory</i>(3TIFF),
113<i>TIFFOpen</i>(3TIFF), <i>TIFFReadDirectory</i>(3TIFF),
114<i>TIFFWriteDirectory</i>(3TIFF), <i>libtiff</i>(3TIFF)</p>
115<!-- INDENTATION -->
116<p>Libtiff library home page:
117<b>http://www.remotesensing.org/libtiff/</b></p>
118</td>
119</table>
120<hr>
121</body>
122</html>