X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_strerror.rst;h=07023b8d94cedfaac0a4d1ad80f1ca9b43e5f842;hb=fbdf9f2089a2653c8ea8150af22852ebc61ce42d;hp=b13458cfcba0a2f478997b657b8b675c3bd9fc25;hpb=f0a568f40ab283bb0be08bd0d930c70386418b97;p=m6w6%2Flibmemcached diff --git a/docs/memcached_strerror.rst b/docs/memcached_strerror.rst index b13458cf..07023b8d 100644 --- a/docs/memcached_strerror.rst +++ b/docs/memcached_strerror.rst @@ -1,82 +1,57 @@ -.. 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 -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 `_ - - -****** -AUTHOR -****** - +`http://libmemcached.org/ `_ -Brian Aker, -******** +-------- SEE ALSO -******** +-------- -memcached(1) libmemcached(3) +:manpage:`memcached(1)` :manpage:`libmemcached(3)`