X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_user_data.rst;h=a0bc602bb0629d4e084f09a28ee2e24969e049db;hb=dbc62573e1a6dc8cbcc97d0898e8615b0916d6ab;hp=2032cbd375f428f3339718762b2841043d988262;hpb=bf12e933c3c73aa04d8de2221144cc73cc9ef3b8;p=awesomized%2Flibmemcached diff --git a/docs/memcached_user_data.rst b/docs/memcached_user_data.rst index 2032cbd3..a0bc602b 100644 --- a/docs/memcached_user_data.rst +++ b/docs/memcached_user_data.rst @@ -2,82 +2,74 @@ Storing custom user information in the client. ============================================== +.. index:: object: memcached_st Manage user specific data -******* +------- LIBRARY -******* +------- C Client Library for memcached (libmemcached, -lmemcached) -******** +-------- SYNOPSIS -******** +-------- -.. code-block:: perl +.. code-block:: c - #include - - void *memcached_get_user_data (memcached_st *ptr); - - void *memcached_set_user_data (memcached_st *ptr, void *data); +#include +.. c:function:: void *memcached_get_user_data (memcached_st *ptr) +.. c:function:: void *memcached_set_user_data (memcached_st *ptr, void *data) -*********** +Compile and link with -lmemcached + + + +----------- DESCRIPTION -*********** +----------- libmemcached(3) allows you to store a pointer to a user specific data inside the memcached_st structure. -memcached_set_user_data() is used to set the user specific data in the -memcached_st structure. +:c:func:`memcached_set_user_data` is used to set the user specific data in the +:c:type:`memcached_st` structure. -memcached_get_user_data() is used to retrieve the user specific data in -the memcached_st structure. +:c:func:`memcached_get_user_data` is used to retrieve the user specific data in the :c:type:`memcached_st` structure. -****** +------ RETURN -****** +------ -memcached_set_user_data() returns the previous value of the user specific -data. +:c:func:`memcached_set_user_data` returns the previous value of the user specific data. -memcached_get_user_data() returns the current value uf the user specific -data. +:c:func:`memcached_get_user_data` returns the current value uf the user specific data. -**** +---- HOME -**** +---- To find out more information please check: -`https://launchpad.net/libmemcached `_ - - -****** -AUTHOR -****** - - -Trond Norbye, +`http://libmemcached.org/ `_ -******** +-------- SEE ALSO -******** +-------- -memcached(1) libmemcached(3) +:manpage:`memcached(1)` :manpage:`libmemcached(3)`