git.m6w6.name Git - awesomized/libmemcached/blob - 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 char *memcached_strerror(memcached_st *ptr, memcached_return rc);
  13
  14 =head1 DESCRIPTION
  15
  16
  17 memcached_strerror() takes a memcached_return value and returns a string
  18 describing the error. memcahed_return values are returned from nearly all
  19 libmemcached functions. They are a set of ENUM values describing all
  20 possibly success and failure operations possible in the library.
  21
  22 memcached_return values are of an ENUM type so that you can set up responses
  23 with switch/case and know that you are capturing all possible return values.
  24
  25 =head1 RETURN
  26
  27 memcached_strerror() returns a string describing a memcached_return value.
  28
  29 =head1 HOME
  30
  31 To find out more information please check: http://tangent.org/552/libmemcached.html
  32
  33 =head1 AUTHOR
  34
  35 Brian Aker, brian@tangent.org
  36
  37 =head1 SEE ALSO
  38
  39 memcached(1) libmemcached(3)
  40
  41 =cut
  42