projects
/
awesomized
/
libmemcached
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
|
github
raw
|
inline
| side by side
Merge lp:~tangent-org/libmemcached/1.0-build Build: jenkins-Libmemcached-1.0-27
[awesomized/libmemcached]
/
docs
/
memcached_user_data.rst
diff --git
a/docs/memcached_user_data.rst
b/docs/memcached_user_data.rst
index 1fd9d334938fb753621c14f8a11fe4c962d8e8c4..a0bc602bb0629d4e084f09a28ee2e24969e049db 100644
(file)
--- a/
docs/memcached_user_data.rst
+++ b/
docs/memcached_user_data.rst
@@
-1,85
+1,75
@@
-.. 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
Manage user specific data
-*******
+-------
LIBRARY
LIBRARY
-*******
+-------
C Client Library for memcached (libmemcached, -lmemcached)
C Client Library for memcached (libmemcached, -lmemcached)
-********
+--------
SYNOPSIS
SYNOPSIS
-********
+--------
+
+
+
+.. code-block:: c
+#include <libmemcached/memcached.h>
+.. c:function:: void *memcached_get_user_data (memcached_st *ptr)
-.. c
ode-block:: perl
+.. c
:function:: void *memcached_set_user_data (memcached_st *ptr, void *data)
- #include <libmemcached/memcached.h>
-
- void *memcached_get_user_data (memcached_st *ptr);
-
- void *memcached_set_user_data (memcached_st *ptr, void *data);
+Compile and link with -lmemcached
-***********
+-----------
DESCRIPTION
DESCRIPTION
-***********
+-----------
libmemcached(3) allows you to store a pointer to a user specific data inside
the memcached_st structure.
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
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
HOME
-****
+----
To find out more information please check:
To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-
-
-******
-AUTHOR
-******
-
-
-Trond Norbye, <trond.norbye@gmail.com>
+`http://libmemcached.org/ <http://libmemcached.org/>`_
-********
+--------
SEE ALSO
SEE ALSO
-********
+--------
-memcached(1) libmemcached(3)
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`