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 :c:func:`memcached_strerror()` takes a :c:type:`memcached_return_t` value and returns a string describing the error.
  25
  26 This string must not be modified by the application.
  27
  28 :c:type:`memcached_return_t` values are returned from nearly all libmemcached(3) functions.
  29
  30 :c:type:`memcached_return_t` values are of an enum type so that you can set up responses with switch/case and know that you are capturing all possible return values.
  31
  32
  33 ------
  34 RETURN
  35 ------
  36
  37
  38 :c:func:`memcached_strerror()` returns a string describing a :c:type:`memcached_return_t` value.
  39
  40
  41 ----
  42 HOME
  43 ----
  44
  45
  46 To find out more information please check:
  47 `http://libmemcached.org/ <http://libmemcached.org/>`_
  48
  49
  50
  51 --------
  52 SEE ALSO
  53 --------
  54
  55
  56 :manpage:`memcached(1)` :manpage:`libmemcached(3)`
  57