libtiff/html/man/TIFFReadRawStrip.3tiff.html
Bob Friesenhahn c3402403ea * html/man/Makefile.am (htmldoc): Fix htmldoc rule so that it can
be used if build directory is not the same as source directory.
* man/{TIFFGetField.3tiff, man/TIFFSetField.3tiff}: Documented
TIFFTAG_PHOTOSHOP, TIFFTAG_RICHTIFFIPTC, and TIFFTAG_XMLPACKET,
and re-sorted tag names in alphabetical order.
2006-01-02 23:50:44 +00:00

99 lines
2.7 KiB
HTML

<!-- Creator : groff version 1.19.2 -->
<!-- CreationDate: Mon Jan 2 17:41:41 2006 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
p { margin-top: 0; margin-bottom: 0; }
pre { margin-top: 0; margin-bottom: 0; }
table { margin-top: 0; margin-bottom: 0; }
</style>
<title>TIFFReadRawStrip</title>
</head>
<body>
<h1 align=center>TIFFReadRawStrip</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#RETURN VALUES">RETURN VALUES</a><br>
<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<hr>
<a name="NAME"></a>
<h2>NAME</h2>
<p style="margin-left:11%; margin-top: 1em">TIFFReadRawStrip
&minus; return the undecoded contents of a strip of data
from an open <small>TIFF</small> file</p>
<a name="SYNOPSIS"></a>
<h2>SYNOPSIS</h2>
<p style="margin-left:11%; margin-top: 1em"><b>#include
&lt;tiffio.h&gt;</b></p>
<p style="margin-left:11%; margin-top: 1em"><b>tsize_t
TIFFReadRawStrip(TIFF *</b><i>tif</i><b>, tstrip_t</b>
<i>strip</i><b>, tdata_t</b> <i>buf</i><b>, tsize_t</b>
<i>size</i><b>)</b></p>
<a name="DESCRIPTION"></a>
<h2>DESCRIPTION</h2>
<p style="margin-left:11%; margin-top: 1em">Read the
contents of the specified strip into the (user supplied)
data buffer. Note that the value of <i>strip</i> is a
&lsquo;&lsquo;raw strip number.&rsquo;&rsquo; That is, the
caller must take into account whether or not the data is
organized in separate planes (<i>PlanarConfiguration</i>=2).
To read a full strip of data the data buffer should
typically be at least as large as the number returned by
<i>TIFFStripSize</i>.</p>
<a name="RETURN VALUES"></a>
<h2>RETURN VALUES</h2>
<p style="margin-left:11%; margin-top: 1em">The actual
number of bytes of data that were placed in <i>buf</i> is
returned; <i>TIFFReadEncodedStrip</i> returns &minus;1 if an
error was encountered.</p>
<a name="DIAGNOSTICS"></a>
<h2>DIAGNOSTICS</h2>
<p style="margin-left:11%; margin-top: 1em">All error
messages are directed to the <b>TIFFError</b>(3TIFF)
routine.</p>
<a name="SEE ALSO"></a>
<h2>SEE ALSO</h2>
<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF),
<b>TIFFReadEncodedStrip</b>(3TIFF),
<b>TIFFReadScanline</b>(3TIFF), <b>TIFFStripSize</b>(3TIFF),
<b>libtiff</b>(3TIFF)</p>
<p style="margin-left:11%; margin-top: 1em">Libtiff library
home page: <b>http://www.remotesensing.org/libtiff/</b></p>
<hr>
</body>
</html>