X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_strerror.rst;h=ce5b1fa0b9bbbd7440b1c1ee76a2ed4c3fecc3a9;hb=6dab5e4d5dfb6145966a3efa48a41cf7e609c9ad;hp=7848a59c567f96346755c19da8b22fe1641512d3;hpb=f285e1b3821f56a8983b5ce9fb1a0070e7bb0a1c;p=awesomized%2Flibmemcached diff --git a/docs/memcached_strerror.rst b/docs/memcached_strerror.rst index 7848a59c..ce5b1fa0 100644 --- a/docs/memcached_strerror.rst +++ b/docs/memcached_strerror.rst @@ -1,40 +1,24 @@ -.. 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 - #include - - 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 @@ -48,34 +32,27 @@ This string must not be modified by the application. 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. -**** +---- HOME -**** +---- To find out more information please check: -`https://launchpad.net/libmemcached `_ - - -****** -AUTHOR -****** - +`http://libmemcached.org/ `_ -Brian Aker, -******** +-------- SEE ALSO -******** +-------- memcached(1) libmemcached(3)