1<!-- Creator     : groff version 1.19.2 -->
2<!-- CreationDate: Mon Jan  2 17:41:48 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>TIFFWriteEncodedStrip</title>
16
17</head>
18<body>
19
20<h1 align=center>TIFFWriteEncodedStrip</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">TIFFWritedEncodedStrip
39&minus; compress and write a strip of data to 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
50TIFFWriteEncodedStrip(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">Compress
59<i>size</i> bytes of raw data from <i>buf</i> and write the
60result to the specified strip; replacing any previously
61written data. Note that the value of <i>strip</i> is a
62&lsquo;&lsquo;raw strip number.&rsquo;&rsquo; That is, the
63caller must take into account whether or not the data are
64organized in separate planes
65(<i>PlanarConfiguration</i>=2).</p>
66
67<a name="NOTES"></a>
68<h2>NOTES</h2>
69
70
71<p style="margin-left:11%; margin-top: 1em">The library
72writes encoded data using the native machine byte order.
73Correctly implemented <small>TIFF</small> readers are
74expected to do any necessary byte-swapping to correctly
75process image data with BitsPerSample greater than 8.</p>
76
77<p style="margin-left:11%; margin-top: 1em">The strip
78number must be valid according to the current settings of
79the <i>ImageLength</i> and <i>RowsPerStrip</i> tags. An
80image may be dynamically grown by increasing the value of
81<i>ImageLength</i> prior to each call to
82<i>TIFFWriteEncodedStrip</i>.</p>
83
84<a name="RETURN VALUES"></a>
85<h2>RETURN VALUES</h2>
86
87
88<p style="margin-left:11%; margin-top: 1em">&minus;1 is
89returned if an error was encountered. Otherwise, the value
90of <i>size</i> is returned.</p>
91
92<a name="DIAGNOSTICS"></a>
93<h2>DIAGNOSTICS</h2>
94
95
96<p style="margin-left:11%; margin-top: 1em">All error
97messages are directed to the <i>TIFFError</i>(3TIFF)
98routine.</p>
99
100<p style="margin-left:11%; margin-top: 1em"><b>%s: File not
101open for writing</b>. The file was opened for reading, not
102writing.</p>
103
104<p style="margin-left:11%; margin-top: 1em"><b>Can not
105write scanlines to a tiled image</b>. The image is assumed
106to be organized in tiles because the <i>TileWidth</i> and
107<i>TileLength</i> tags have been set with
108<i>TIFFSetField</i>(3TIFF).</p>
109
110<p style="margin-left:11%; margin-top: 1em"><b>%s: Must set
111&quot;ImageWidth&quot; before writing data</b>. The
112image&rsquo;s width has not be set before the first write.
113See <i>TIFFSetField</i>(3TIFF) for information on how to do
114this.</p>
115
116<p style="margin-left:11%; margin-top: 1em"><b>%s: Must set
117&quot;PlanarConfiguration&quot; before writing data</b>. The
118organization of data has not be defined before the first
119write. See <i>TIFFSetField</i>(3TIFF) for information on how
120to do this.</p>
121
122<p style="margin-left:11%; margin-top: 1em"><b>%s: No space
123for strip arrays&quot;</b>. There was not enough space for
124the arrays that hold strip offsets and byte counts.</p>
125
126<a name="SEE ALSO"></a>
127<h2>SEE ALSO</h2>
128
129
130
131<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF),
132<b>TIFFWriteScanline</b>(3TIFF),
133<b>TIFFWriteRawStrip</b>(3TIFF), <b>libtiff</b>(3TIFF)</p>
134
135<p style="margin-left:11%; margin-top: 1em">Libtiff library
136home page: <b>http://www.remotesensing.org/libtiff/</b></p>
137<hr>
138</body>
139</html>
140