summaryrefslogtreecommitdiff
path: root/docs/memcached_version.rst
blob: 20b8b25a20150943bcf2e0f7f238ab5d0476ae1c (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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
=======================================================
Getting version information about the client and server
=======================================================

 
--------
SYNOPSIS
--------

#include <libmemcached/memcached.h>

.. c:function:: const char * memcached_lib_version (void) 

.. c:function:: memcached_return_t memcached_version (memcached_st *ptr)


Compile and link with -lmemcached



-----------
DESCRIPTION
-----------


:c:func:`memcached_lib_version` is used to return a simple version string representing the libmemcached version (client library version, not server version)

:c:func:`memcached_version` is used to set the major, minor, and micro versions of each memcached server being used by the memcached_st connection structure. It returns the memcached server return code.


------
RETURN
------


:c:func:`memcached_lib_version` returns a string with the version of the libmemcached driver.

A value of :c:type:`memcached_return_t` is returned from :c:func:'memcached_version'

On success that value will be :c:type:`MEMCACHED_SUCCESS`. 

If called with the :c:func:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set, the value :c:type:`MEMCACHED_NOT_SUPPORTED` will be returned. 

Use :c:func:`memcached_strerror` to translate this value to 
a printable string.


----
HOME
----


To find out more information please check:
`http://libmemcached.org/ <http://libmemcached.org/>`_


--------
SEE ALSO
--------


:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`