Merge of build trunk.
[awesomized/libmemcached] / docs / man / memcached_strerror.3
1 .TH "MEMCACHED_STRERROR" "3" "October 18, 2011" "1.01" "libmemcached"
2 .SH NAME
3 memcached_strerror \- libmemcached Documentation
4 .
5 .nr rst2man-indent-level 0
6 .
7 .de1 rstReportMargin
8 \\$1 \\n[an-margin]
9 level \\n[rst2man-indent-level]
10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
11 -
12 \\n[rst2man-indent0]
13 \\n[rst2man-indent1]
14 \\n[rst2man-indent2]
15 ..
16 .de1 INDENT
17 .\" .rstReportMargin pre:
18 . RS \\$1
19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20 . nr rst2man-indent-level +1
21 .\" .rstReportMargin post:
22 ..
23 .de UNINDENT
24 . RE
25 .\" indent \\n[an-margin]
26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27 .nr rst2man-indent-level -1
28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
30 ..
31 .\" Man page generated from reStructeredText.
32 .
33 .SH SYNOPSIS
34 .sp
35 #include <libmemcached/memcached.h>
36 .INDENT 0.0
37 .TP
38 .B const char * memcached_strerror (memcached_st *ptr, memcached_return_t rc);
39 .UNINDENT
40 .sp
41 Compile and link with \-lmemcached
42 .SH DESCRIPTION
43 .sp
44 \fBmemcached_strerror()\fP takes a \fBmemcached_return_t\fP value and returns a string describing the error.
45 .sp
46 This string must not be modified by the application.
47 .sp
48 \fBmemcached_return_t\fP values are returned from nearly all libmemcached(3) functions.
49 .sp
50 \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.
51 .SH RETURN
52 .sp
53 \fBmemcached_strerror()\fP returns a string describing a \fBmemcached_return_t\fP value.
54 .SH HOME
55 .sp
56 To find out more information please check:
57 \fI\%http://libmemcached.org/\fP
58 .SH SEE ALSO
59 .sp
60 \fImemcached(1)\fP \fIlibmemcached(3)\fP
61 .SH AUTHOR
62 Brian Aker
63 .SH COPYRIGHT
64 2011, Brian Aker DataDifferential, http://datadifferential.com/
65 .\" Generated by docutils manpage writer.
66 .\"
67 .