summaryrefslogtreecommitdiff
path: root/doc/functions/TIFFFieldName.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/functions/TIFFFieldName.rst')
-rw-r--r--doc/functions/TIFFFieldName.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/functions/TIFFFieldName.rst b/doc/functions/TIFFFieldName.rst
new file mode 100644
index 00000000..e4ceace5
--- /dev/null
+++ b/doc/functions/TIFFFieldName.rst
@@ -0,0 +1,30 @@
+TIFFFieldName
+=============
+
+Synopsis
+--------
+
+.. highlight:: c
+
+::
+
+ #include <tiffio.h>
+
+.. c:function:: const char* TIFFFieldName(const TIFFField* fip)
+
+Description
+-----------
+
+:c:func:`TIFFFieldName` returns the textual name for a TIFF field.
+*fip* is a field information pointer previously returned by
+:c:func:`TIFFFindField`, :c:func:`TIFFFieldWithTag`, or :c:func:`TIFFFieldWithName`.
+
+Return values
+-------------
+
+:c:func:`TIFFFieldName` returns a constant C string.
+
+See also
+--------
+
+:doc:`libtiff` (3tiff),