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

   1 =head1 NAME
   2
   3 memcached_lib_version, memcached_version - Get library version
   4
   5 =head1 LIBRARY
   6
   7 C Client Library for memcached (libmemcached, -lmemcached)
   8
   9 =head1 SYNOPSIS
  10
  11   #include <memcached.h>
  12
  13   const char *
  14     memcached_lib_version (void)
  15
  16
  17   memcached_return_t
  18     memcached_version (memcached_st *ptr)
  19
  20
  21 =head1 DESCRIPTION
  22
  23 memcached_lib_version() is used to return a simple version string representing
  24 the libmemcached version (version of the client library, not server)
  25
  26
  27 memcached_version() is used to set the major, minor, and micro versions of each
  28 memcached server being used by the memcached_st connection structure. It returns the
  29 memcached server return code.
  30
  31 =head1 RETURN
  32
  33 A string with the version of libmemcached driver is returned from
  34 memcached_lib_version()
  35
  36 A value of type C<memcached_return_t> is returned from memcached_version()
  37 On success that value will be C<MEMCACHED_SUCCESS>. If called with the
  38 C<MEMCACHED_BEHAVIOR_USE_UDP> behavior set, the value C<MEMCACHED_NOT_SUPPORTED>
  39 will be returned. Use memcached_strerror() to translate this value to
  40 a printable string.
  41
  42 =head1 HOME
  43
  44 To find out more information please check:
  45 L<https://launchpad.net/libmemcached>
  46
  47 =head1 AUTHOR
  48
  49 Brian Aker, E<lt>brian@tangent.orgE<gt>
  50
  51 =head1 SEE ALSO
  52
  53 memcached(1) libmemcached(3) memcached_strerror(3)
  54
  55 =cut
  56