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

   1 ================================================
   2 Coverting Errors, memcached_return_t, to strings
   3 ================================================
   4
   5
   6 .. index:: object: memcached_st
   7
   8 --------
   9 SYNOPSIS
  10 --------
  11
  12 #include <libmemcached/memcached.h>
  13
  14 .. c:function:: const char * memcached_strerror (memcached_st *ptr, memcached_return_t rc);
  15
  16 Compile and link with -lmemcached
  17
  18
  19 -----------
  20 DESCRIPTION
  21 -----------
  22
  23
  24 memcached_strerror() takes a \ ``memcached_return_t``\  value and returns a string
  25 describing the error.
  26
  27 This string must not be modified by the application.
  28
  29 \ ``memcached_return_t``\  values are returned from nearly all libmemcached(3) functions.
  30
  31 \ ``memcached_return_t``\  values are of an enum type so that you can set up responses
  32 with switch/case and know that you are capturing all possible return values.
  33
  34
  35 ------
  36 RETURN
  37 ------
  38
  39
  40 memcached_strerror() returns a string describing a \ ``memcached_return_t``\  value.
  41
  42
  43 ----
  44 HOME
  45 ----
  46
  47
  48 To find out more information please check:
  49 `http://libmemcached.org/ <http://libmemcached.org/>`_
  50
  51
  52
  53 --------
  54 SEE ALSO
  55 --------
  56
  57
  58 memcached(1) libmemcached(3)
  59