bf5d35e8b6fbd562ccbbef4930bb1e020f6ead61
[awesomized/libmemcached] / docs / man / memcached_strerror.3
1 .TH "MEMCACHED_STRERROR" "3" "April 13, 2011" "0.47" "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 LIBRARY
34 .sp
35 C Client Library for memcached (libmemcached, \-lmemcached)
36 .SS SYNOPSIS
37 .sp
38 .nf
39 .ft C
40 #include <libmemcached/memcached.h>
41
42 const char *
43 memcached_strerror (memcached_st *ptr,
44 memcached_return_t rc);
45 .ft P
46 .fi
47 .SS DESCRIPTION
48 .sp
49 memcached_strerror() takes a \fBmemcached_return_t\fP value and returns a string
50 describing the error.
51 .sp
52 This string must not be modified by the application.
53 .sp
54 \fBmemcached_return_t\fP values are returned from nearly all libmemcached(3) functions.
55 .sp
56 \fBmemcached_return_t\fP values are of an enum type so that you can set up responses
57 with switch/case and know that you are capturing all possible return values.
58 .SH RETURN
59 .sp
60 memcached_strerror() returns a string describing a \fBmemcached_return_t\fP value.
61 .SH HOME
62 .sp
63 To find out more information please check:
64 \fI\%http://libmemcached.org/\fP
65 .SH AUTHOR
66 .sp
67 Brian Aker, <\fI\%brian@tangent.org\fP>
68 .SS SEE ALSO
69 .sp
70 memcached(1) libmemcached(3)
71 .SH AUTHOR
72 Brian Aker
73 .SH COPYRIGHT
74 2011, Brian Aker DataDifferential, http://datadifferential.com/
75 .\" Generated by docutils manpage writer.
76 .\"
77 .