summaryrefslogtreecommitdiff
path: root/doc/functions/TIFFClientInfo.rst
blob: 7576d225ef319a06d6227a71956509ede43d410e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
TIFFClientInfo
==============

Synopsis
--------

.. highlight:: c

::

    #include <tiffio.h>

.. c:function:: void *TIFFGetClientInfo(TIFF* tif, const char *name)

.. c:function:: void TIFFSetClientInfo(TIFF* tif, void *data, const char *name)

Description
-----------

.. TODO: Check explanation of clientinfo linked list intention and usage.

The *clientinfo* linked list provides a method to hand over user defined
data from one routine to another via the internal ``tif`` storage of the
``libtiff`` library.

:c:func:`TIFFGetClientInfo` returns a pointer to the data of the named entry
in the clientinfo-list. If the *name* is not found ``NULL`` is returned.

:c:func:`TIFFSetClientInfo` adds or replaces an entry in the clientinfo-list
with the *name* and the pointer to the *data* provided by the caller.

Diagnostics
-----------

None.

See also
--------

:doc:`libtiff` (3tiff),