Updating for 1.0.2 release
[awesomized/libmemcached] / docs / memcached_user_data.rst
1 ==============================================
2 Storing custom user information in the client.
3 ==============================================
4
5 .. index:: object: memcached_st
6
7 Manage user specific data
8
9
10 -------
11 LIBRARY
12 -------
13
14
15 C Client Library for memcached (libmemcached, -lmemcached)
16
17
18 --------
19 SYNOPSIS
20 --------
21
22
23
24 .. code-block:: perl
25
26 #include <libmemcached/memcached.h>
27
28 void *memcached_get_user_data (memcached_st *ptr);
29
30 void *memcached_set_user_data (memcached_st *ptr, void *data);
31
32
33
34 -----------
35 DESCRIPTION
36 -----------
37
38
39 libmemcached(3) allows you to store a pointer to a user specific data inside
40 the memcached_st structure.
41
42 :c:func:`memcached_set_user_data()` is used to set the user specific data in the
43 :c:type:`memcached_st` structure.
44
45 :c:func:`memcached_get_user_data()` is used to retrieve the user specific data in the :c:type:`memcached_st` structure.
46
47
48 ------
49 RETURN
50 ------
51
52
53 :c:func:`memcached_set_user_data()` returns the previous value of the user specific data.
54
55 :c:func:`memcached_get_user_data()` returns the current value uf the user specific data.
56
57
58 ----
59 HOME
60 ----
61
62
63 To find out more information please check:
64 `http://libmemcached.org/ <http://libmemcached.org/>`_
65
66
67 --------
68 SEE ALSO
69 --------
70
71
72 :manpage:`memcached(1)` :manpage:`libmemcached(3)`
73