TIFFFieldPassCount

Section: Misc. Reference Manual Pages (3TIFF)
Updated: July 26, 2012
Index Return to Main Contents

NAME

TIFFFieldPassCount - Get whether to pass a count to TIFFGet/SetField

SYNOPSIS

#include <tiffio.h>

int TIFFFieldPassCount(const TIFFField* fip)

DESCRIPTION

TIFFFieldPassCount returns true (nonzero) if TIFFGetField and TIFFSetField expect a count value to be passed before the actual data pointer.

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

When a count is required, it will be of type uint32 when TIFFFieldReadCount reports TIFF_VARIABLE2, and of type uint16 otherwise. (This distinction is critical for use of TIFFGetField, but normally not so for use of TIFFSetField.)

RETURN VALUES

TIFFFieldPassCount returns an integer that is always 1 (true) or 0 (false).

Index