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

   1 .TH "MEMCACHED_STRERROR" "3" "May 23, 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 SYNOPSIS
  34 .sp
  35 #include <libmemcached/memcached.h>
  36 .INDENT 0.0
  37 .TP
  38 .B const char * memcached_strerror (memcached_st *ptr, memcached_return_t rc);
  39 .UNINDENT
  40 .sp
  41 Compile and link with \-lmemcached
  42 .SH DESCRIPTION
  43 .sp
  44 memcached_strerror() takes a \fBmemcached_return_t\fP value and returns a string
  45 describing the error.
  46 .sp
  47 This string must not be modified by the application.
  48 .sp
  49 \fBmemcached_return_t\fP values are returned from nearly all libmemcached(3) functions.
  50 .sp
  51 \fBmemcached_return_t\fP values are of an enum type so that you can set up responses
  52 with switch/case and know that you are capturing all possible return values.
  53 .SH RETURN
  54 .sp
  55 memcached_strerror() returns a string describing a \fBmemcached_return_t\fP value.
  56 .SH HOME
  57 .sp
  58 To find out more information please check:
  59 \fI\%http://libmemcached.org/\fP
  60 .SH SEE ALSO
  61 .sp
  62 memcached(1) libmemcached(3)
  63 .SH AUTHOR
  64 Brian Aker
  65 .SH COPYRIGHT
  66 2011, Brian Aker DataDifferential, http://datadifferential.com/
  67 .\" Generated by docutils manpage writer.
  68 .\"
  69 .