Merge from Trond
[m6w6/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 void *memcached_set_user_data(memcached_st *ptr, void *data);
15
16 =head1 DESCRIPTION
17
18 libmemcached(3) allows you to store a pointer to a user specific data inside
19 the memcached_st structure.
20
21 memcached_set_user_data() is used to set the user specific data in the
22 memcached_st structure.
23
24 memcached_get_user_data() is used to retrieve the user specific data in
25 the memcached_st structure.
26
27 =head1 RETURN
28
29 memcached_set_user_data() returns the previous value of the user specific
30 data.
31
32 memcached_get_user_data() returns the current value uf the user specific
33 data.
34
35 =head1 HOME
36
37 To find out more information please check:
38 L<http://tangent.org/552/libmemcached.html>
39
40 =head1 AUTHOR
41
42 Trond Norbye, E<lt>trond.norbye@sun.comE<gt>
43
44 =head1 SEE ALSO
45
46 memcached(1) libmemcached(3)
47
48 =cut
49