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

   1 ================================================
   2 Coverting Errors, memcached_return_t, to strings
   3 ================================================
   4
   5
   6 *******
   7 LIBRARY
   8 *******
   9
  10
  11 C Client Library for memcached (libmemcached, -lmemcached)
  12
  13
  14 --------
  15 SYNOPSIS
  16 --------
  17
  18
  19
  20 .. code-block:: perl
  21
  22    #include <libmemcached/memcached.h>
  23
  24    const char *
  25      memcached_strerror (memcached_st *ptr,
  26                          memcached_return_t rc);
  27
  28
  29
  30 -----------
  31 DESCRIPTION
  32 -----------
  33
  34
  35 memcached_strerror() takes a \ ``memcached_return_t``\  value and returns a string
  36 describing the error.
  37
  38 This string must not be modified by the application.
  39
  40 \ ``memcached_return_t``\  values are returned from nearly all libmemcached(3) functions.
  41
  42 \ ``memcached_return_t``\  values are of an enum type so that you can set up responses
  43 with switch/case and know that you are capturing all possible return values.
  44
  45
  46 ******
  47 RETURN
  48 ******
  49
  50
  51 memcached_strerror() returns a string describing a \ ``memcached_return_t``\  value.
  52
  53
  54 ****
  55 HOME
  56 ****
  57
  58
  59 To find out more information please check:
  60 `http://libmemcached.org/ <http://libmemcached.org/>`_
  61
  62
  63 ******
  64 AUTHOR
  65 ******
  66
  67
  68 Brian Aker, <brian@tangent.org>
  69
  70
  71 --------
  72 SEE ALSO
  73 --------
  74
  75
  76 memcached(1) libmemcached(3)
  77