git.m6w6.name Git - awesomized/libmemcached/blob - docs/memcached_version.rst

   1 =======================================================
   2 Getting version information about the client and server
   3 =======================================================
   4
   5
   6 --------
   7 SYNOPSIS
   8 --------
   9
  10 #include <libmemcached/memcached.h>
  11
  12 .. c:function:: const char * memcached_lib_version (void)
  13
  14 .. c:function:: memcached_return_t memcached_version (memcached_st *ptr)
  15
  16
  17 Compile and link with -lmemcached
  18
  19
  20
  21 -----------
  22 DESCRIPTION
  23 -----------
  24
  25
  26 :c:func:`memcached_lib_version()` is used to return a simple version string representing the libmemcached version (client library version, not server version)
  27
  28 :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.
  29
  30
  31 ------
  32 RETURN
  33 ------
  34
  35
  36 :c:func:`memcached_lib_version()` returns a string with the version of the libmemcached driver.
  37
  38 A value of :c:type:`memcached_return_t` is returned from :c:func:'memcached_version()'
  39
  40 On success that value will be :c:type:`MEMCACHED_SUCCESS`.
  41
  42 If called with the :c:func:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set, the value :c:type:`MEMCACHED_NOT_SUPPORTED` will be returned.
  43
  44 Use :c:func:`memcached_strerror()` to translate this value to
  45 a printable string.
  46
  47
  48 ----
  49 HOME
  50 ----
  51
  52
  53 To find out more information please check:
  54 `http://libmemcached.org/ <http://libmemcached.org/>`_
  55
  56
  57 --------
  58 SEE ALSO
  59 --------
  60
  61
  62 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
  63