TIFFFIELDPASSCOUNT(3tiff) LibTIFF TIFFFIELDPASSCOUNT(3tiff)
TIFFFieldPassCount - get whether to pass a count to
TIFFGetField/TIFFSetField
#include <tiffio.h>
int TIFFFieldPassCount(const TIFFField *fip)
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(), TIFFFieldWithName().
When a count is required, it will be of type uint32_t if
TIFFFieldReadCount() reports TIFF_VARIABLE2, and of type uint16_t
otherwise. Use TIFFFieldWriteCount() for TIFFSetField(),
respectively. (This distinction is critical for use of
TIFFGetField(), but normally not so for use of TIFFSetField().)
An alternative function for the count value determination is
TIFFFieldSetGetCountSize().
TIFFFieldPassCount() returns an integer that is always 1 (true) or 0
(false).
TIFFFieldDataType (3tiff), TIFFFieldName (3tiff), TIFFFieldQuery
(3tiff), TIFFFieldReadCount (3tiff), TIFFFieldTag (3tiff),
TIFFFieldWriteCount (3tiff), libtiff
LibTIFF contributors
1988-2025, LibTIFF contributors
4.7 March 7, 2026 TIFFFIELDPASSCOUNT(3tiff)
NAME
TIFFFieldPassCount - get whether to pass a count to
TIFFGetField/TIFFSetField
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(), TIFFFieldWithName().
When a count is required, it will be of type uint32_t if
TIFFFieldReadCount() reports TIFF_VARIABLE2, and of type uint16_t
otherwise. Use TIFFFieldWriteCount() for TIFFSetField(),
respectively. (This distinction is critical for use of
TIFFGetField(), but normally not so for use of TIFFSetField().)
An alternative function for the count value determination is
TIFFFieldSetGetCountSize().
RETURN VALUES
TIFFFieldPassCount() returns an integer that is always 1 (true) or 0
(false).
SEE ALSO
TIFFFieldDataType (3tiff), TIFFFieldName (3tiff), TIFFFieldQuery
(3tiff), TIFFFieldReadCount (3tiff), TIFFFieldTag (3tiff),
TIFFFieldWriteCount (3tiff), libtiff
AUTHOR
LibTIFF contributors
COPYRIGHT
1988-2025, LibTIFF contributors
4.7 March 7, 2026 TIFFFIELDPASSCOUNT(3tiff)