TIFFFieldWriteCount.3tiff.html 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  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>TIFFFieldWriteCount</title>
  17. </head>
  18. <body>
  19. <h1 align="center">TIFFFieldWriteCount</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">TIFFFieldWriteCount
  30. &minus; Get number of values to be written to field</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. TIFFFieldWriteCount(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>TIFFFieldWriteCount</b>
  43. returns the number of values to be written into the
  44. specified TIFF field; that is, the number of arguments that
  45. should be supplied to <b>TIFFSetField</b>. For most field
  46. types this is a small positive integer, typically 1 or 2,
  47. but there are some special values: <b><br>
  48. TIFF_VARIABLE</b> indicates that a variable number of values
  49. is possible; then, a <b>uint16_t</b> <i>count</i> argument and
  50. a pointer <i>data</i> argument must be supplied to
  51. <b>TIFFSetField</b>. <b><br>
  52. TIFF_VARIABLE2</b> is the same as <b>TIFF_VARIABLE</b>
  53. except that the <i>count</i> argument must have type
  54. <b>uint32_t</b>. (On most modern machines, this makes no
  55. practical difference, and the <i>count</i> argument can
  56. simply be an <b>int</b> in either case.) <b><br>
  57. TIFF_SPP</b> indicates that the number of arguments must be
  58. equal to the image&rsquo;s number of samples per pixel.</p>
  59. <p style="margin-left:11%; margin-top: 1em"><i>fip</i> is a
  60. field information pointer previously returned by
  61. <b>TIFFFindField</b>, <b>TIFFFieldWithTag</b>, or
  62. <b>TIFFFieldWithName</b>.</p>
  63. <p style="margin-left:11%; margin-top: 1em">For most field
  64. types, <b>TIFFFieldWriteCount</b> returns the same value as
  65. <b>TIFFFieldReadCount</b>, but there are some
  66. exceptions.</p>
  67. <h2>RETURN VALUES
  68. <a name="RETURN VALUES"></a>
  69. </h2>
  70. <p style="margin-left:11%; margin-top: 1em"><b>TIFFFieldWriteCount</b>
  71. returns an integer.</p>
  72. <h2>SEE ALSO
  73. <a name="SEE ALSO"></a>
  74. </h2>
  75. <p style="margin-left:11%; margin-top: 1em"><b>libtiff</b>(3TIFF),</p>
  76. <p style="margin-left:11%; margin-top: 1em">Libtiff library
  77. home page: <b>http://www.simplesystems.org/libtiff/</b></p>
  78. <hr>
  79. </body>
  80. </html>