diff options
Diffstat (limited to 'doc/functions/TIFFFieldTag.rst')
-rw-r--r-- | doc/functions/TIFFFieldTag.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/functions/TIFFFieldTag.rst b/doc/functions/TIFFFieldTag.rst new file mode 100644 index 00000000..9c7f58d0 --- /dev/null +++ b/doc/functions/TIFFFieldTag.rst @@ -0,0 +1,33 @@ +TIFFFieldTag +============ + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: uint32_t TIFFFieldTag(const TIFFField* fip) + +Description +----------- + +:c:func:`TIFFFieldTag` returns the numeric tag value for a TIFF field. +This can be compared to various constants exported by the :program:`libtiff` +header files, such as :c:macro:`TIFFTAG_IMAGEWIDTH`. + +*fip* is a field information pointer previously returned by +:c:func:`TIFFFindField`, :c:func:`TIFFFieldWithTag`, or :c:func:`TIFFFieldWithName`. + +Return values +------------- + +:c:func:`TIFFFieldTag` returns an integer tag value. + +See also +-------- + +:doc:`libtiff` (3tiff) |