libtiff/html/man/TIFFReadRawStrip.3tiff.html

110 lines
3.3 KiB
HTML
Raw Normal View History

2006-03-13 10:06:17 -05:00
<!-- Creator : groff version 1.18.1 -->
2007-02-24 10:03:47 -05:00
<!-- CreationDate: Sat Feb 24 17:59:57 2007 -->
2005-03-06 06:11:43 -05:00
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta name="Content-Style" content="text/css">
<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>
2006-03-13 10:06:17 -05:00
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="8%"></td>
<td width="91%">
<p>TIFFReadRawStrip &minus; return the undecoded contents of
a strip of data from an open <small>TIFF</small> file</p>
</td>
</table>
2005-03-06 06:11:43 -05:00
<a name="SYNOPSIS"></a>
<h2>SYNOPSIS</h2>
2006-03-13 10:06:17 -05:00
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="8%"></td>
<td width="91%">
<p><b>#include &lt;tiffio.h&gt;</b></p>
<!-- INDENTATION -->
<p><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>
</td>
</table>
2005-03-06 06:11:43 -05:00
<a name="DESCRIPTION"></a>
<h2>DESCRIPTION</h2>
2006-03-13 10:06:17 -05:00
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="8%"></td>
<td width="91%">
<p>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
2005-03-06 06:11:43 -05:00
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>
2006-03-13 10:06:17 -05:00
</td>
</table>
2005-03-06 06:11:43 -05:00
<a name="RETURN VALUES"></a>
<h2>RETURN VALUES</h2>
2006-03-13 10:06:17 -05:00
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="8%"></td>
<td width="91%">
<p>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>
</td>
</table>
2005-03-06 06:11:43 -05:00
<a name="DIAGNOSTICS"></a>
<h2>DIAGNOSTICS</h2>
2006-03-13 10:06:17 -05:00
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="8%"></td>
<td width="91%">
<p>All error messages are directed to the
<b>TIFFError</b>(3TIFF) routine.</p>
</td>
</table>
2005-03-06 06:11:43 -05:00
<a name="SEE ALSO"></a>
<h2>SEE ALSO</h2>
2006-03-13 10:06:17 -05:00
<!-- INDENTATION -->
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="8%"></td>
<td width="91%">
<p><b>TIFFOpen</b>(3TIFF),
2005-12-29 17:01:44 -05:00
<b>TIFFReadEncodedStrip</b>(3TIFF),
<b>TIFFReadScanline</b>(3TIFF), <b>TIFFStripSize</b>(3TIFF),
<b>libtiff</b>(3TIFF)</p>
2006-03-13 10:06:17 -05:00
<!-- INDENTATION -->
<p>Libtiff library home page:
<b>http://www.remotesensing.org/libtiff/</b></p>
</td>
</table>
2005-03-06 06:11:43 -05:00
<hr>
</body>
</html>