src/tiff/man/TIFFFieldPassCount.3tiff

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