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

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