TIFFFieldPassCount(3tiff)

TIFFFieldPassCount3tiff

Get whether to pass a count to tiffgetfield/tiffsetfield

Usage

#include <tiffio.h>
int TIFFFieldPassCount(const TIFFField *fip)

Overview

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).

Releases

6 releases since Debian 8 (Jessie); the text changed 4 times.

  1. 8
  2. 9
  3. 10–11
  4. 12
  5. 13

Author

LibTIFF contributors

From libtiff-dev 4.7.0-3+deb13u3 in Debian 13 (Trixie). Parsed by carta from the page's man source.