summaryrefslogtreecommitdiff
path: root/docs/man/memcached_strerror.3
blob: 20d81eaa38a1600c6a45337c052f0ec3312c643c (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
58
59
60
61
62
63
64
65
66
67
.TH "MEMCACHED_STRERROR" "3" "August 02, 2012" "1.0.10" "libmemcached"
.SH NAME
memcached_strerror \- libmemcached Documentation
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.
.SH SYNOPSIS
.sp
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
.B const char * memcached_strerror(memcached_st\fI\ *ptr\fP, memcached_return_t\fI\ rc\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
\fI\%memcached_strerror()\fP takes a \fBmemcached_return_t\fP value and returns a string describing the error.
.sp
This string must not be modified by the application.
.sp
\fBmemcached_return_t\fP values are returned from nearly all libmemcached(3) functions.
.sp
\fBmemcached_return_t\fP 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.
.SH RETURN
.sp
\fI\%memcached_strerror()\fP returns a string describing a \fBmemcached_return_t\fP value.
.SH HOME
.sp
To find out more information please check:
\fI\%http://libmemcached.org/\fP
.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\" 
.