src/tiff/html/man/TIFFFieldPassCount.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>TIFFFieldPassCount</title>
  17
  18 </head>
  19 <body>
  20
  21 <h1 align="center">TIFFFieldPassCount</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">TIFFFieldPassCount
  39 &minus; Get whether to pass a count to TIFFGet/SetField</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 TIFFFieldPassCount(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>TIFFFieldPassCount</b>
  60 returns true (nonzero) if <b>TIFFGetField</b> and
  61 <b>TIFFSetField</b> expect a <i>count</i> value to be passed
  62 before the actual data pointer.</p>
  63
  64 <p style="margin-left:11%; margin-top: 1em"><i>fip</i> is a
  65 field information pointer previously returned by
  66 <b>TIFFFindField</b>, <b>TIFFFieldWithTag</b>, or
  67 <b>TIFFFieldWithName</b>.</p>
  68
  69 <p style="margin-left:11%; margin-top: 1em">When a
  70 <i>count</i> is required, it will be of type <b>uint32</b>
  71 when <b>TIFFFieldReadCount</b> reports
  72 <b>TIFF_VARIABLE2</b>, and of type <b>uint16</b> otherwise.
  73 (This distinction is critical for use of
  74 <b>TIFFGetField</b>, but normally not so for use of
  75 <b>TIFFSetField</b>.)</p>
  76
  77 <h2>RETURN VALUES
  78 <a name="RETURN VALUES"></a>
  79 </h2>
  80
  81
  82
  83 <p style="margin-left:11%; margin-top: 1em"><b>TIFFFieldPassCount</b>
  84 returns an integer that is always 1 (true) or 0 (false).</p>
  85
  86 <h2>SEE ALSO
  87 <a name="SEE ALSO"></a>
  88 </h2>
  89
  90
  91
  92 <p style="margin-left:11%; margin-top: 1em"><b>libtiff</b>(3TIFF),</p>
  93
  94 <p style="margin-left:11%; margin-top: 1em">Libtiff library
  95 home page: <b>http://www.remotesensing.org/libtiff/</b></p>
  96 <hr>
  97 </body>
  98 </html>