X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_strerror.rst;h=07023b8d94cedfaac0a4d1ad80f1ca9b43e5f842;hb=fc21f9b9bc7d55fc4ce9d7a323b9e9173dbbe3ba;hp=18e21c60101086b0b09f50e3b1b7b3fe0f23490a;hpb=bf12e933c3c73aa04d8de2221144cc73cc9ef3b8;p=m6w6%2Flibmemcached diff --git a/docs/memcached_strerror.rst b/docs/memcached_strerror.rst index 18e21c60..07023b8d 100644 --- a/docs/memcached_strerror.rst +++ b/docs/memcached_strerror.rst @@ -3,75 +3,55 @@ Coverting Errors, memcached_return_t, to strings ================================================ -******* -LIBRARY -******* +.. index:: object: memcached_st - -C Client Library for memcached (libmemcached, -lmemcached) - - -******** +-------- SYNOPSIS -******** - +-------- +#include -.. code-block:: perl +.. c:function:: const char * memcached_strerror (memcached_st *ptr, memcached_return_t rc) - #include - - 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)`