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

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