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

   1 .. highlight:: perl
   2
   3
   4 memcached_strerror
   5 ******************
   6
   7
   8 Get error string
   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_strerror (memcached_st *ptr,
  31                          memcached_return_t rc);
  32
  33
  34
  35 ***********
  36 DESCRIPTION
  37 ***********
  38
  39
  40 memcached_strerror() takes a \ ``memcached_return_t``\  value and returns a string
  41 describing the error.
  42
  43 This string must not be modified by the application.
  44
  45 \ ``memcached_return_t``\  values are returned from nearly all libmemcached(3) functions.
  46
  47 \ ``memcached_return_t``\  values are of an enum type so that you can set up responses
  48 with switch/case and know that you are capturing all possible return values.
  49
  50
  51 ******
  52 RETURN
  53 ******
  54
  55
  56 memcached_strerror() returns a string describing a \ ``memcached_return_t``\  value.
  57
  58
  59 ****
  60 HOME
  61 ****
  62
  63
  64 To find out more information please check:
  65 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
  66
  67
  68 ******
  69 AUTHOR
  70 ******
  71
  72
  73 Brian Aker, <brian@tangent.org>
  74
  75
  76 ********
  77 SEE ALSO
  78 ********
  79
  80
  81 memcached(1) libmemcached(3)
  82