X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_user_data.rst;h=45482f70da4ae97315fb27b293659cca61b16fae;hb=c7cf10015c179608f1b6e3d1614ae744b21d0f98;hp=1fd9d334938fb753621c14f8a11fe4c962d8e8c4;hpb=1edb76c1dfdf6307d010307b6f04bed3ce22e3a2;p=awesomized%2Flibmemcached diff --git a/docs/memcached_user_data.rst b/docs/memcached_user_data.rst index 1fd9d334..45482f70 100644 --- a/docs/memcached_user_data.rst +++ b/docs/memcached_user_data.rst @@ -1,24 +1,23 @@ -.. highlight:: perl - - -memcached_set_user_data, memcached_get_user_data -************************************************ +============================================== +Storing custom user information in the client. +============================================== +.. index:: object: memcached_st Manage user specific data -******* +------- LIBRARY -******* +------- C Client Library for memcached (libmemcached, -lmemcached) -******** +-------- SYNOPSIS -******** +-------- @@ -32,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)`