-.. highlight:: perl
+================================================
+Coverting Errors, memcached_return_t, to strings
+================================================
-memcached_strerror
-******************
+.. index:: object: memcached_st
-
-Get error string
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
-********
+--------
SYNOPSIS
-********
-
-
+--------
-.. code-block:: perl
+#include <libmemcached/memcached.h>
- #include <memcached.h>
-
- const char *
- memcached_strerror (memcached_st *ptr,
- memcached_return_t rc);
+.. c:function:: const char * memcached_strerror (memcached_st *ptr, memcached_return_t rc);
+Compile and link with -lmemcached
-***********
+-----------
DESCRIPTION
-***********
+-----------
-memcached_strerror() takes a \ ``memcached_return_t``\ value and returns a string
-describing the error.
+:c:func:`memcached_strerror()` takes a :c:type:`memcached_return_t` value and returns a string describing the error.
This string must not be modified by the application.
-\ ``memcached_return_t``\ values are returned from nearly all libmemcached(3) functions.
+:c:type:`memcached_return_t` values are returned from nearly all libmemcached(3) functions.
-\ ``memcached_return_t``\ values are of an enum type so that you can set up responses
-with switch/case and know that you are capturing all possible return values.
+:c:type:`memcached_return_t` values are of an enum type so that you can set up responses with switch/case and know that you are capturing all possible return values.
-******
+------
RETURN
-******
+------
-memcached_strerror() returns a string describing a \ ``memcached_return_t``\ value.
+:c:func:`memcached_strerror()` returns a string describing a :c:type:`memcached_return_t` value.
-****
+----
HOME
-****
+----
To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-
-
-******
-AUTHOR
-******
-
+`http://libmemcached.org/ <http://libmemcached.org/>`_
-Brian Aker, <brian@tangent.org>
-********
+--------
SEE ALSO
-********
+--------
-memcached(1) libmemcached(3)
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`