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

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