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

   1 .. highlight:: perl
   2
   3
   4 memcached_lib_version, memcached_version
   5 ****************************************
   6
   7
   8 Get library version
   9
  10
  11 *******
  12 LIBRARY
  13 *******
  14
  15
  16 C Client Library for memcached (libmemcached, -lmemcached)
  17
  18
  19 ********
  20 SYNOPSIS
  21 ********
  22
  23
  24
  25 .. code-block:: perl
  26
  27    #include <libmemcached/memcached.h>
  28
  29    const char *
  30      memcached_lib_version (void)
  31
  32
  33    memcached_return_t
  34      memcached_version (memcached_st *ptr)
  35
  36
  37
  38 ***********
  39 DESCRIPTION
  40 ***********
  41
  42
  43 memcached_lib_version() is used to return a simple version string representing
  44 the libmemcached version (version of the client library, not server)
  45
  46 memcached_version() is used to set the major, minor, and micro versions of each
  47 memcached server being used by the memcached_st connection structure. It returns the
  48 memcached server return code.
  49
  50
  51 ******
  52 RETURN
  53 ******
  54
  55
  56 A string with the version of libmemcached driver is returned from
  57 memcached_lib_version()
  58
  59 A value of type \ ``memcached_return_t``\  is returned from memcached_version()
  60 On success that value will be \ ``MEMCACHED_SUCCESS``\ . If called with the
  61 \ ``MEMCACHED_BEHAVIOR_USE_UDP``\  behavior set, the value \ ``MEMCACHED_NOT_SUPPORTED``\
  62 will be returned. Use memcached_strerror() to translate this value to
  63 a printable string.
  64
  65
  66 ****
  67 HOME
  68 ****
  69
  70
  71 To find out more information please check:
  72 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
  73
  74
  75 ******
  76 AUTHOR
  77 ******
  78
  79
  80 Brian Aker, <brian@tangent.org>
  81
  82
  83 ********
  84 SEE ALSO
  85 ********
  86
  87
  88 memcached(1) libmemcached(3) memcached_strerror(3)
  89