← Back to branch summary

~brianaker/libmemcached/1164440

« back to all changes in this revision

Viewing changes to docs/memcached_strerror.pod

Merging bzr://gaz.tangent.org/libmemcached/build/ to Build branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/memcached_strerror.pod
1
 
=head1 NAME
2
 
 
3
 
memcached_strerror
4
 
 
5
 
=head1 LIBRARY
6
 
 
7
 
C Client Library for memcached (libmemcached, -lmemcached)
8
 
 
9
 
=head1 SYNOPSIS
10
 
 
11
 
  #include <memcached.h>
12
 
 
13
 
  char *memcached_strerror (memcached_st *ptr,
14
 
                            memcached_return rc);
15
 
 
16
 
=head1 DESCRIPTION
17
 
 
18
 
memcached_strerror() takes a C<memcached_return> value and returns a string
19
 
describing the error.
20
 
 
21
 
This string must not be modified by the application.
22
 
 
23
 
C<memcached_return> values are returned from nearly all libmemcached(3) functions.
24
 
 
25
 
C<memcached_return> values are of an enum type so that you can set up responses
26
 
with switch/case and know that you are capturing all possible return values.
27
 
 
28
 
=head1 RETURN
29
 
 
30
 
memcached_strerror() returns a string describing a C<memcached_return> value.
31
 
 
32
 
=head1 HOME
33
 
 
34
 
To find out more information please check:
35
 
L<http://tangent.org/552/libmemcached.html>
36
 
 
37
 
=head1 AUTHOR
38
 
 
39
 
Brian Aker, E<lt>brian@tangent.orgE<gt>
40
 
 
41
 
=head1 SEE ALSO
42
 
 
43
 
memcached(1) libmemcached(3)
44
 
 
45
 
=cut
46