X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_user_data.rst;h=45482f70da4ae97315fb27b293659cca61b16fae;hb=256805451de4f0dc6fe3b976894483b43313f46e;hp=2032cbd375f428f3339718762b2841043d988262;hpb=bf12e933c3c73aa04d8de2221144cc73cc9ef3b8;p=m6w6%2Flibmemcached diff --git a/docs/memcached_user_data.rst b/docs/memcached_user_data.rst index 2032cbd3..45482f70 100644 --- a/docs/memcached_user_data.rst +++ b/docs/memcached_user_data.rst @@ -2,21 +2,22 @@ Storing custom user information in the client. ============================================== +.. index:: object: memcached_st Manage user specific data -******* +------- LIBRARY -******* +------- C Client Library for memcached (libmemcached, -lmemcached) -******** +-------- SYNOPSIS -******** +-------- @@ -30,54 +31,43 @@ SYNOPSIS -*********** +----------- 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)`