src/tiff/html/man/TIFFReadRawStrip.3tiff.html

   1 <!-- Creator     : groff version 1.18.1 -->
   2 <!-- CreationDate: Sat Feb 24 18:37:17 2007 -->
   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>TIFFReadRawStrip</title>
   8 </head>
   9 <body>
  10
  11 <h1 align=center>TIFFReadRawStrip</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>TIFFReadRawStrip &minus; return the undecoded contents of
  29 a strip of data from 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>tsize_t TIFFReadRawStrip(TIFF *</b><i>tif</i><b>,
  43 tstrip_t</b> <i>strip</i><b>, tdata_t</b> <i>buf</i><b>,
  44 tsize_t</b> <i>size</i><b>)</b></p>
  45 </td>
  46 </table>
  47 <a name="DESCRIPTION"></a>
  48 <h2>DESCRIPTION</h2>
  49 <!-- INDENTATION -->
  50 <table width="100%" border=0 rules="none" frame="void"
  51        cols="2" cellspacing="0" cellpadding="0">
  52 <tr valign="top" align="left">
  53 <td width="8%"></td>
  54 <td width="91%">
  55 <p>Read the contents of the specified strip into the (user
  56 supplied) data buffer. Note that the value of <i>strip</i>
  57 is a &lsquo;&lsquo;raw strip number.&rsquo;&rsquo; That is,
  58 the caller must take into account whether or not the data is
  59 organized in separate planes (<i>PlanarConfiguration</i>=2).
  60 To read a full strip of data the data buffer should
  61 typically be at least as large as the number returned by
  62 <i>TIFFStripSize</i>.</p>
  63 </td>
  64 </table>
  65 <a name="RETURN VALUES"></a>
  66 <h2>RETURN VALUES</h2>
  67 <!-- INDENTATION -->
  68 <table width="100%" border=0 rules="none" frame="void"
  69        cols="2" cellspacing="0" cellpadding="0">
  70 <tr valign="top" align="left">
  71 <td width="8%"></td>
  72 <td width="91%">
  73 <p>The actual number of bytes of data that were placed in
  74 <i>buf</i> is returned; <i>TIFFReadEncodedStrip</i> returns
  75 &minus;1 if an error was encountered.</p>
  76 </td>
  77 </table>
  78 <a name="DIAGNOSTICS"></a>
  79 <h2>DIAGNOSTICS</h2>
  80 <!-- INDENTATION -->
  81 <table width="100%" border=0 rules="none" frame="void"
  82        cols="2" cellspacing="0" cellpadding="0">
  83 <tr valign="top" align="left">
  84 <td width="8%"></td>
  85 <td width="91%">
  86 <p>All error messages are directed to the
  87 <b>TIFFError</b>(3TIFF) routine.</p>
  88 </td>
  89 </table>
  90 <a name="SEE ALSO"></a>
  91 <h2>SEE ALSO</h2>
  92 <!-- INDENTATION -->
  93 <table width="100%" border=0 rules="none" frame="void"
  94        cols="2" cellspacing="0" cellpadding="0">
  95 <tr valign="top" align="left">
  96 <td width="8%"></td>
  97 <td width="91%">
  98 <p><b>TIFFOpen</b>(3TIFF),
  99 <b>TIFFReadEncodedStrip</b>(3TIFF),
 100 <b>TIFFReadScanline</b>(3TIFF), <b>TIFFStripSize</b>(3TIFF),
 101 <b>libtiff</b>(3TIFF)</p>
 102 <!-- INDENTATION -->
 103 <p>Libtiff library home page:
 104 <b>http://www.remotesensing.org/libtiff/</b></p>
 105 </td>
 106 </table>
 107 <hr>
 108 </body>
 109 </html>