TIFFFieldPassCount.3tiff.html 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. <!-- Creator : groff version 1.21 -->
  2. <!-- CreationDate: Sun Jul 29 12:12:01 2012 -->
  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; vertical-align: top }
  12. pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
  13. table { margin-top: 0; margin-bottom: 0; vertical-align: top }
  14. h1 { text-align: center }
  15. </style>
  16. <title>TIFFFieldPassCount</title>
  17. </head>
  18. <body>
  19. <h1 align="center">TIFFFieldPassCount</h1>
  20. <a href="#NAME">NAME</a><br>
  21. <a href="#SYNOPSIS">SYNOPSIS</a><br>
  22. <a href="#DESCRIPTION">DESCRIPTION</a><br>
  23. <a href="#RETURN VALUES">RETURN VALUES</a><br>
  24. <a href="#SEE ALSO">SEE ALSO</a><br>
  25. <hr>
  26. <h2>NAME
  27. <a name="NAME"></a>
  28. </h2>
  29. <p style="margin-left:11%; margin-top: 1em">TIFFFieldPassCount
  30. &minus; Get whether to pass a count to TIFFGet/SetField</p>
  31. <h2>SYNOPSIS
  32. <a name="SYNOPSIS"></a>
  33. </h2>
  34. <p style="margin-left:11%; margin-top: 1em"><b>#include
  35. &lt;tiffio.h&gt;</b></p>
  36. <p style="margin-left:11%; margin-top: 1em"><b>int
  37. TIFFFieldPassCount(const TIFFField*</b>
  38. <i>fip</i><b>)</b></p>
  39. <h2>DESCRIPTION
  40. <a name="DESCRIPTION"></a>
  41. </h2>
  42. <p style="margin-left:11%; margin-top: 1em"><b>TIFFFieldPassCount</b>
  43. returns true (nonzero) if <b>TIFFGetField</b> and
  44. <b>TIFFSetField</b> expect a <i>count</i> value to be passed
  45. before the actual data pointer.</p>
  46. <p style="margin-left:11%; margin-top: 1em"><i>fip</i> is a
  47. field information pointer previously returned by
  48. <b>TIFFFindField</b>, <b>TIFFFieldWithTag</b>, or
  49. <b>TIFFFieldWithName</b>.</p>
  50. <p style="margin-left:11%; margin-top: 1em">When a
  51. <i>count</i> is required, it will be of type <b>uint32_t</b>
  52. when <b>TIFFFieldReadCount</b> reports
  53. <b>TIFF_VARIABLE2</b>, and of type <b>uint16_t</b> otherwise.
  54. (This distinction is critical for use of
  55. <b>TIFFGetField</b>, but normally not so for use of
  56. <b>TIFFSetField</b>.)</p>
  57. <h2>RETURN VALUES
  58. <a name="RETURN VALUES"></a>
  59. </h2>
  60. <p style="margin-left:11%; margin-top: 1em"><b>TIFFFieldPassCount</b>
  61. returns an integer that is always 1 (true) or 0 (false).</p>
  62. <h2>SEE ALSO
  63. <a name="SEE ALSO"></a>
  64. </h2>
  65. <p style="margin-left:11%; margin-top: 1em"><b>libtiff</b>(3TIFF),</p>
  66. <p style="margin-left:11%; margin-top: 1em">Libtiff library
  67. home page: <b>http://www.simplesystems.org/libtiff/</b></p>
  68. <hr>
  69. </body>
  70. </html>