597335ac9152b016210830d167cbfa47c384f27e
[awesomized/libmemcached] / docs / memcached_user_data.pod
1 =head1 NAME
2
3 memcached_set_user_data, memcached_get_user_data - Manage user specific data
4
5 =head1 LIBRARY
6
7 C Client Library for memcached (libmemcached, -lmemcached)
8
9 =head1 SYNOPSIS
10
11 #include <memcached.h>
12
13 void *memcached_get_user_data (memcached_st *ptr);
14
15 void *memcached_set_user_data (memcached_st *ptr, void *data);
16
17 =head1 DESCRIPTION
18
19 libmemcached(3) allows you to store a pointer to a user specific data inside
20 the memcached_st structure.
21
22 memcached_set_user_data() is used to set the user specific data in the
23 memcached_st structure.
24
25 memcached_get_user_data() is used to retrieve the user specific data in
26 the memcached_st structure.
27
28 =head1 RETURN
29
30 memcached_set_user_data() returns the previous value of the user specific
31 data.
32
33 memcached_get_user_data() returns the current value uf the user specific
34 data.
35
36 =head1 HOME
37
38 To find out more information please check:
39 L<http://tangent.org/552/libmemcached.html>
40
41 =head1 AUTHOR
42
43 Trond Norbye, E<lt>trond.norbye@sun.comE<gt>
44
45 =head1 SEE ALSO
46
47 memcached(1) libmemcached(3)
48
49 =cut
50