1<!-- Creator     : groff version 1.19.2 -->
2<!-- CreationDate: Mon Jan  2 17:41:40 2006 -->
3<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
4"http://www.w3.org/TR/html4/loose.dtd">
5<html>
6<head>
7<meta name="generator" content="groff -Thtml, see www.gnu.org">
8<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
9<meta name="Content-Style" content="text/css">
10<style type="text/css">
11       p     { margin-top: 0; margin-bottom: 0; }
12       pre   { margin-top: 0; margin-bottom: 0; }
13       table { margin-top: 0; margin-bottom: 0; }
14</style>
15<title>TIFFReadEncodedStrip</title>
16
17</head>
18<body>
19
20<h1 align=center>TIFFReadEncodedStrip</h1>
21
22<a href="#NAME">NAME</a><br>
23<a href="#SYNOPSIS">SYNOPSIS</a><br>
24<a href="#DESCRIPTION">DESCRIPTION</a><br>
25<a href="#NOTES">NOTES</a><br>
26<a href="#RETURN VALUES">RETURN VALUES</a><br>
27<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
28<a href="#SEE ALSO">SEE ALSO</a><br>
29
30<hr>
31
32
33<a name="NAME"></a>
34<h2>NAME</h2>
35
36
37
38<p style="margin-left:11%; margin-top: 1em">TIFFReadEncodedStrip
39&minus; read and decode a strip of data from an open
40<small>TIFF</small> file</p>
41
42<a name="SYNOPSIS"></a>
43<h2>SYNOPSIS</h2>
44
45
46<p style="margin-left:11%; margin-top: 1em"><b>#include
47&lt;tiffio.h&gt;</b></p>
48
49<p style="margin-left:11%; margin-top: 1em"><b>tsize_t
50TIFFReadEncodedStrip(TIFF *</b><i>tif</i><b>, tstrip_t</b>
51<i>strip</i><b>, tdata_t</b> <i>buf</i><b>, tsize_t</b>
52<i>size</i><b>)</b></p>
53
54<a name="DESCRIPTION"></a>
55<h2>DESCRIPTION</h2>
56
57
58<p style="margin-left:11%; margin-top: 1em">Read the
59specified strip of data and place up to <i>size</i> bytes of
60decompressed information in the (user supplied) data
61buffer.</p>
62
63<a name="NOTES"></a>
64<h2>NOTES</h2>
65
66
67<p style="margin-left:11%; margin-top: 1em">The value of
68<i>strip</i> is a &lsquo;&lsquo;raw strip
69number.&rsquo;&rsquo; That is, the caller must take into
70account whether or not the data are organized in separate
71planes (<i>PlanarConfiguration</i>=2). To read a full strip
72of data the data buffer should typically be at least as
73large as the number returned by <b>TIFFStripSize</b>(3TIFF).
74If the -1 passed in <i>size</i> parameter, the whole strip
75will be read. You should be sure you have enough space
76allocated for the buffer.</p>
77
78<p style="margin-left:11%; margin-top: 1em">The library
79attempts to hide bit- and byte-ordering differences between
80the image and the native machine by converting data to the
81native machine order. Bit reversal is done if the
82<i>FillOrder</i> tag is opposite to the native machine bit
83order. 16- and 32-bit samples are automatically byte-swapped
84if the file was written with a byte order opposite to the
85native machine byte order,</p>
86
87<a name="RETURN VALUES"></a>
88<h2>RETURN VALUES</h2>
89
90
91<p style="margin-left:11%; margin-top: 1em">The actual
92number of bytes of data that were placed in <i>buf</i> is
93returned; <i>TIFFReadEncodedStrip</i> returns &minus;1 if an
94error was encountered.</p>
95
96<a name="DIAGNOSTICS"></a>
97<h2>DIAGNOSTICS</h2>
98
99
100<p style="margin-left:11%; margin-top: 1em">All error
101messages are directed to the <b>TIFFError</b>(3TIFF)
102routine.</p>
103
104<a name="SEE ALSO"></a>
105<h2>SEE ALSO</h2>
106
107
108
109<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF),
110<b>TIFFReadRawStrip</b>(3TIFF),
111<b>TIFFReadScanline</b>(3TIFF), <b>libtiff</b>(3TIFF)</p>
112
113<p style="margin-left:11%; margin-top: 1em">Libtiff library
114home page: <b>http://www.remotesensing.org/libtiff/</b></p>
115<hr>
116</body>
117</html>
118