src/tiff/man/TIFFFieldWriteCount.3tiff

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