git.m6w6.name Git - awesomized/libmemcached/blob - docs/memcached_strerror.pod

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