src/tiff/man/TIFFFieldPassCount.3tiff

   1 .\"
   2 .\" Copyright (c) 2012, Tom Lane <tgl@sss.pgh.pa.us>
   3 .\"
   4 .\" Permission to use, copy, modify, distribute, and sell this software and
   5 .\" its documentation for any purpose is hereby granted without fee, provided
   6 .\" that (i) the above copyright notices and this permission notice appear in
   7 .\" all copies of the software and related documentation, and (ii) the names of
   8 .\" Sam Leffler and Silicon Graphics may not be used in any advertising or
   9 .\" publicity relating to the software without the specific, prior written
  10 .\" permission of Sam Leffler and Silicon Graphics.
  11 .\"
  12 .\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
  13 .\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  14 .\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  15 .\"
  16 .\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
  17 .\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
  18 .\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  19 .\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  20 .\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  21 .\" OF THIS SOFTWARE.
  22 .\"
  23 .if n .po 0
  24 .TH TIFFFieldPassCount 3TIFF "July 26, 2012" "libtiff"
  25 .SH NAME
  26 TIFFFieldPassCount \- Get whether to pass a count to TIFFGet/SetField
  27 .SH SYNOPSIS
  28 .B "#include <tiffio.h>"
  29 .sp
  30 .BI "int TIFFFieldPassCount(const TIFFField* " fip ")"
  31 .SH DESCRIPTION
  32 .BR TIFFFieldPassCount
  33 returns true (nonzero) if
  34 .BR TIFFGetField
  35 and
  36 .BR TIFFSetField
  37 expect a
  38 .I count
  39 value to be passed before the actual data pointer.
  40 .P
  41 .I fip
  42 is a field information pointer previously returned by
  43 .BR TIFFFindField ,
  44 .BR TIFFFieldWithTag ,
  45 or
  46 .BR TIFFFieldWithName .
  47 .P
  48 When a
  49 .I count
  50 is required, it will be of type
  51 .BR uint32
  52 when
  53 .BR TIFFFieldReadCount
  54 reports
  55 .BR TIFF_VARIABLE2 ,
  56 and of type
  57 .BR uint16
  58 otherwise.  (This distinction is critical for use of
  59 .BR TIFFGetField ,
  60 but normally not so for use of
  61 .BR TIFFSetField .)
  62 .br
  63 .SH "RETURN VALUES"
  64 .br
  65 .BR TIFFFieldPassCount
  66 returns an integer that is always 1 (true) or 0 (false).
  67 .br
  68 .SH "SEE ALSO"
  69 .BR libtiff (3TIFF),
  70 .PP
  71 Libtiff library home page:
  72 .BR http://www.remotesensing.org/libtiff/