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

   1 .TH "MEMCACHED_LIB_VERSION" "3" "June 17, 2011" "0.49" "libmemcached"
   2 .SH NAME
   3 memcached_lib_version \- 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_lib_version(void)
  39 .UNINDENT
  40 .INDENT 0.0
  41 .TP
  42 .B memcached_return_t memcached_version(memcached_st\fI\ *ptr\fP)
  43 .UNINDENT
  44 .sp
  45 Compile and link with \-lmemcached
  46 .SH DESCRIPTION
  47 .sp
  48 memcached_lib_version() is used to return a simple version string representing
  49 the libmemcached version (client library version, not server version)
  50 .sp
  51 memcached_version() is used to set the major, minor, and micro versions of each
  52 memcached server being used by the memcached_st connection structure. It returns the
  53 memcached server return code.
  54 .SH RETURN
  55 .sp
  56 A string with the version of libmemcached driver is returned from
  57 memcached_lib_version()
  58 .sp
  59 A value of type \fBmemcached_return_t\fP is returned from memcached_version()
  60 On success that value will be \fBMEMCACHED_SUCCESS\fP. If called with the
  61 \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior set, the value \fBMEMCACHED_NOT_SUPPORTED\fPwill be returned. Use memcached_strerror() to translate this value to
  62 a printable string.
  63 .SH HOME
  64 .sp
  65 To find out more information please check:
  66 \fI\%http://libmemcached.org/\fP
  67 .SH SEE ALSO
  68 .sp
  69 memcached(1) libmemcached(3) memcached_strerror(3)
  70 .SH AUTHOR
  71 Brian Aker
  72 .SH COPYRIGHT
  73 2011, Brian Aker DataDifferential, http://datadifferential.com/
  74 .\" Generated by docutils manpage writer.
  75 .\"
  76 .