$Id: TIFFFieldWriteCount.3tiff,v 1.2 2016-09-25 20:05:49 bfriesen Exp $

Copyright (c) 2012, Tom Lane <tgl@sss.pgh.pa.us>

Permission to use, copy, modify, distribute, and sell this software and
its documentation for any purpose is hereby granted without fee, provided
that (i) the above copyright notices and this permission notice appear in
all copies of the software and related documentation, and (ii) the names of
Sam Leffler and Silicon Graphics may not be used in any advertising or
publicity relating to the software without the specific, prior written
permission of Sam Leffler and Silicon Graphics.

THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
OF THIS SOFTWARE.

TIFFFieldWriteCount 3TIFF "July 26, 2012" "libtiff"
NAME
TIFFFieldWriteCount - Get number of values to be written to field
SYNOPSIS
"#include <tiffio.h>" "int TIFFFieldWriteCount(const TIFFField* " fip ")"
DESCRIPTION
TIFFFieldWriteCount returns the number of values to be written into the specified TIFF field; that is, the number of arguments that should be supplied to TIFFSetField . For most field types this is a small positive integer, typically 1 or 2, but there are some special values:

TIFF_VARIABLE indicates that a variable number of values is possible; then, a uint16 count argument and a pointer data argument must be supplied to TIFFSetField .

TIFF_VARIABLE2 is the same as TIFF_VARIABLE except that the count argument must have type uint32 . (On most modern machines, this makes no practical difference, and the count argument can simply be an int in either case.)

TIFF_SPP indicates that the number of arguments must be equal to the image's number of samples per pixel.

fip is a field information pointer previously returned by TIFFFindField , TIFFFieldWithTag , or TIFFFieldWithName .

For most field types, TIFFFieldWriteCount returns the same value as TIFFFieldReadCount , but there are some exceptions.

"RETURN VALUES"

TIFFFieldWriteCount returns an integer.

"SEE ALSO"
libtiff (3TIFF),

Libtiff library home page: http://www.simplesystems.org/libtiff/