src/tiff/html/man/TIFFFieldReadCount.3tiff.html

   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>TIFFFieldReadCount</title>
  17
  18 </head>
  19 <body>
  20
  21 <h1 align="center">TIFFFieldReadCount</h1>
  22
  23 <a href="#NAME">NAME</a><br>
  24 <a href="#SYNOPSIS">SYNOPSIS</a><br>
  25 <a href="#DESCRIPTION">DESCRIPTION</a><br>
  26 <a href="#RETURN VALUES">RETURN VALUES</a><br>
  27 <a href="#SEE ALSO">SEE ALSO</a><br>
  28
  29 <hr>
  30
  31
  32 <h2>NAME
  33 <a name="NAME"></a>
  34 </h2>
  35
  36
  37
  38 <p style="margin-left:11%; margin-top: 1em">TIFFFieldReadCount
  39 &minus; Get number of values to be read from field</p>
  40
  41 <h2>SYNOPSIS
  42 <a name="SYNOPSIS"></a>
  43 </h2>
  44
  45
  46 <p style="margin-left:11%; margin-top: 1em"><b>#include
  47 &lt;tiffio.h&gt;</b></p>
  48
  49 <p style="margin-left:11%; margin-top: 1em"><b>int
  50 TIFFFieldReadCount(const TIFFField*</b>
  51 <i>fip</i><b>)</b></p>
  52
  53 <h2>DESCRIPTION
  54 <a name="DESCRIPTION"></a>
  55 </h2>
  56
  57
  58
  59 <p style="margin-left:11%; margin-top: 1em"><b>TIFFFieldReadCount</b>
  60 returns the number of values available to be read from the
  61 specified TIFF field; that is, the number of arguments that
  62 should be supplied to <b>TIFFGetField</b>. For most field
  63 types this is a small positive integer, typically 1 or 2,
  64 but there are some special values: <b><br>
  65 TIFF_VARIABLE</b> indicates that a variable number of values
  66 is possible; then, a <b>uint16</b> <i>count</i> argument and
  67 a pointer <i>data</i> argument must be supplied to
  68 <b>TIFFGetField</b>. <b><br>
  69 TIFF_VARIABLE2</b> is the same as <b>TIFF_VARIABLE</b>
  70 except that the <i>count</i> argument must have type
  71 <b>uint32</b>. <b><br>
  72 TIFF_SPP</b> indicates that the number of arguments is equal
  73 to the image&rsquo;s number of samples per pixel.</p>
  74
  75 <p style="margin-left:11%; margin-top: 1em"><i>fip</i> is a
  76 field information pointer previously returned by
  77 <b>TIFFFindField</b>, <b>TIFFFieldWithTag</b>, or
  78 <b>TIFFFieldWithName</b>.</p>
  79
  80 <h2>RETURN VALUES
  81 <a name="RETURN VALUES"></a>
  82 </h2>
  83
  84
  85
  86 <p style="margin-left:11%; margin-top: 1em"><b>TIFFFieldReadCount</b>
  87 returns an integer.</p>
  88
  89 <h2>SEE ALSO
  90 <a name="SEE ALSO"></a>
  91 </h2>
  92
  93
  94
  95 <p style="margin-left:11%; margin-top: 1em"><b>libtiff</b>(3TIFF),</p>
  96
  97 <p style="margin-left:11%; margin-top: 1em">Libtiff library
  98 home page: <b>http://www.remotesensing.org/libtiff/</b></p>
  99 <hr>
 100 </body>
 101 </html>