roentgen b75cab
.\" $Id: TIFFFieldPassCount.3tiff,v 1.1 2012-07-29 15:45:29 tgl Exp $
roentgen b75cab
.\"
roentgen b75cab
.\" Copyright (c) 2012, Tom Lane <tgl@sss.pgh.pa.us></tgl@sss.pgh.pa.us>
roentgen b75cab
.\"
roentgen b75cab
.\" Permission to use, copy, modify, distribute, and sell this software and 
roentgen b75cab
.\" its documentation for any purpose is hereby granted without fee, provided
roentgen b75cab
.\" that (i) the above copyright notices and this permission notice appear in
roentgen b75cab
.\" all copies of the software and related documentation, and (ii) the names of
roentgen b75cab
.\" Sam Leffler and Silicon Graphics may not be used in any advertising or
roentgen b75cab
.\" publicity relating to the software without the specific, prior written
roentgen b75cab
.\" permission of Sam Leffler and Silicon Graphics.
roentgen b75cab
.\" 
roentgen b75cab
.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
roentgen b75cab
.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
roentgen b75cab
.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
roentgen b75cab
.\" 
roentgen b75cab
.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
roentgen b75cab
.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
roentgen b75cab
.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
roentgen b75cab
.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF 
roentgen b75cab
.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 
roentgen b75cab
.\" OF THIS SOFTWARE.
roentgen b75cab
.\"
roentgen b75cab
.if n .po 0
roentgen b75cab
.TH TIFFFieldPassCount 3TIFF "July 26, 2012" "libtiff"
roentgen b75cab
.SH NAME
roentgen b75cab
TIFFFieldPassCount \- Get whether to pass a count to TIFFGet/SetField
roentgen b75cab
.SH SYNOPSIS
roentgen b75cab
.B "#include <tiffio.h>"</tiffio.h>
roentgen b75cab
.sp
roentgen b75cab
.BI "int TIFFFieldPassCount(const TIFFField* " fip ")"
roentgen b75cab
.SH DESCRIPTION
roentgen b75cab
.BR TIFFFieldPassCount
roentgen b75cab
returns true (nonzero) if
roentgen b75cab
.BR TIFFGetField
roentgen b75cab
and
roentgen b75cab
.BR TIFFSetField
roentgen b75cab
expect a
roentgen b75cab
.I count
roentgen b75cab
value to be passed before the actual data pointer.
roentgen b75cab
.P
roentgen b75cab
.I fip
roentgen b75cab
is a field information pointer previously returned by
roentgen b75cab
.BR TIFFFindField ,
roentgen b75cab
.BR TIFFFieldWithTag ,
roentgen b75cab
or
roentgen b75cab
.BR TIFFFieldWithName .
roentgen b75cab
.P
roentgen b75cab
When a
roentgen b75cab
.I count
roentgen b75cab
is required, it will be of type
roentgen b75cab
.BR uint32
roentgen b75cab
when
roentgen b75cab
.BR TIFFFieldReadCount
roentgen b75cab
reports
roentgen b75cab
.BR TIFF_VARIABLE2 ,
roentgen b75cab
and of type
roentgen b75cab
.BR uint16
roentgen b75cab
otherwise.  (This distinction is critical for use of
roentgen b75cab
.BR TIFFGetField ,
roentgen b75cab
but normally not so for use of
roentgen b75cab
.BR TIFFSetField .)
roentgen b75cab
.br
roentgen b75cab
.SH "RETURN VALUES"
roentgen b75cab
.br
roentgen b75cab
.BR TIFFFieldPassCount
roentgen b75cab
returns an integer that is always 1 (true) or 0 (false).
roentgen b75cab
.br
roentgen b75cab
.SH "SEE ALSO"
roentgen b75cab
.BR libtiff (3TIFF),
roentgen b75cab
.PP
roentgen b75cab
Libtiff library home page:
roentgen b75cab
.BR http://www.remotesensing.org/libtiff/