src/tiff/man/TIFFFieldWriteCount.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 TIFFFieldWriteCount 3TIFF "July 26, 2012" "libtiff"
  25 .SH NAME
  26 TIFFFieldWriteCount \- Get number of values to be written to field
  27 .SH SYNOPSIS
  28 .B "#include <tiffio.h>"
  29 .sp
  30 .BI "int TIFFFieldWriteCount(const TIFFField* " fip ")"
  31 .SH DESCRIPTION
  32 .BR TIFFFieldWriteCount
  33 returns the number of values to be written into the specified
  34 TIFF field; that is, the number of arguments that should be supplied to
  35 .BR TIFFSetField .
  36 For most field types this is a small positive integer, typically 1 or 2,
  37 but there are some special values:
  38 .br
  39 .BR TIFF_VARIABLE
  40 indicates that a variable number of values is possible; then, a
  41 .BR uint16
  42 .I count
  43 argument and a pointer
  44 .I data
  45 argument must be supplied to
  46 .BR TIFFSetField .
  47 .br
  48 .BR TIFF_VARIABLE2
  49 is the same as
  50 .BR TIFF_VARIABLE
  51 except that the
  52 .I count
  53 argument must have type
  54 .BR uint32 .
  55 (On most modern machines, this makes no practical difference, and the
  56 .I count
  57 argument can simply be an
  58 .BR int
  59 in either case.)
  60 .br
  61 .BR TIFF_SPP
  62 indicates that the number of arguments must be equal to the image's
  63 number of samples per pixel.
  64 .P
  65 .I fip
  66 is a field information pointer previously returned by
  67 .BR TIFFFindField ,
  68 .BR TIFFFieldWithTag ,
  69 or
  70 .BR TIFFFieldWithName .
  71 .P
  72 For most field types,
  73 .BR TIFFFieldWriteCount
  74 returns the same value as
  75 .BR TIFFFieldReadCount ,
  76 but there are some exceptions.
  77 .br
  78 .SH "RETURN VALUES"
  79 .br
  80 .BR TIFFFieldWriteCount
  81 returns an integer.
  82 .br
  83 .SH "SEE ALSO"
  84 .BR libtiff (3TIFF),
  85 .PP
  86 Libtiff library home page:
  87 .BR http://www.remotesensing.org/libtiff/