TIFFReadRawStrip.3tiff.html 3.3 KB

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