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 memcached_lib_version() is used to return a simple version string representing
  27 the libmemcached version (client library version, not server version)
  28
  29 memcached_version() is used to set the major, minor, and micro versions of each
  30 memcached server being used by the memcached_st connection structure. It returns the
  31 memcached server return code.
  32
  33
  34 ------
  35 RETURN
  36 ------
  37
  38
  39 A string with the version of libmemcached driver is returned from
  40 memcached_lib_version()
  41
  42 A value of type \ ``memcached_return_t``\  is returned from memcached_version()
  43 On success that value will be \ ``MEMCACHED_SUCCESS``\ . If called with the
  44 \ ``MEMCACHED_BEHAVIOR_USE_UDP``\  behavior set, the value \ ``MEMCACHED_NOT_SUPPORTED``\
  45 will be returned. Use memcached_strerror() to translate this value to
  46 a printable string.
  47
  48
  49 ----
  50 HOME
  51 ----
  52
  53
  54 To find out more information please check:
  55 `http://libmemcached.org/ <http://libmemcached.org/>`_
  56
  57
  58 --------
  59 SEE ALSO
  60 --------
  61
  62
  63 memcached(1) libmemcached(3) memcached_strerror(3)
  64