summaryrefslogtreecommitdiff
path: root/docs/memcached_strerror.rst
blob: 07023b8d94cedfaac0a4d1ad80f1ca9b43e5f842 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
================================================
Coverting Errors, memcached_return_t, to strings
================================================


.. index:: object: memcached_st

--------
SYNOPSIS
--------

#include <libmemcached/memcached.h>

.. c:function:: const char * memcached_strerror (memcached_st *ptr, memcached_return_t rc)

Compile and link with -lmemcached


-----------
DESCRIPTION
-----------


:c:func:`memcached_strerror` takes a :c:type:`memcached_return_t` value and returns a string describing the error.

This string must not be modified by the application.

:c:type:`memcached_return_t` values are returned from nearly all libmemcached(3) functions.

: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.


------
RETURN
------


:c:func:`memcached_strerror` returns a string describing a :c:type:`memcached_return_t` value.


----
HOME
----


To find out more information please check:
`http://libmemcached.org/ <http://libmemcached.org/>`_



--------
SEE ALSO
--------


:manpage:`memcached(1)` :manpage:`libmemcached(3)`