Merge in updates to doc/build of memaslap.
[m6w6/libmemcached] / docs / man / memcached_user_data.3
1 .TH "MEMCACHED_USER_DATA" "3" "June 02, 2011" "0.47" "libmemcached"
2 .SH NAME
3 memcached_user_data \- libmemcached Documentation
4 .
5 .nr rst2man-indent-level 0
6 .
7 .de1 rstReportMargin
8 \\$1 \\n[an-margin]
9 level \\n[rst2man-indent-level]
10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
11 -
12 \\n[rst2man-indent0]
13 \\n[rst2man-indent1]
14 \\n[rst2man-indent2]
15 ..
16 .de1 INDENT
17 .\" .rstReportMargin pre:
18 . RS \\$1
19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20 . nr rst2man-indent-level +1
21 .\" .rstReportMargin post:
22 ..
23 .de UNINDENT
24 . RE
25 .\" indent \\n[an-margin]
26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27 .nr rst2man-indent-level -1
28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
30 ..
31 .\" Man page generated from reStructeredText.
32 .
33 .sp
34 Manage user specific data
35 .SH LIBRARY
36 .sp
37 C Client Library for memcached (libmemcached, \-lmemcached)
38 .SH SYNOPSIS
39 .sp
40 .nf
41 .ft C
42 #include <libmemcached/memcached.h>
43
44 void *memcached_get_user_data (memcached_st *ptr);
45
46 void *memcached_set_user_data (memcached_st *ptr, void *data);
47 .ft P
48 .fi
49 .SH DESCRIPTION
50 .sp
51 libmemcached(3) allows you to store a pointer to a user specific data inside
52 the memcached_st structure.
53 .sp
54 memcached_set_user_data() is used to set the user specific data in the
55 memcached_st structure.
56 .sp
57 memcached_get_user_data() is used to retrieve the user specific data in
58 the memcached_st structure.
59 .SH RETURN
60 .sp
61 memcached_set_user_data() returns the previous value of the user specific
62 data.
63 .sp
64 memcached_get_user_data() returns the current value uf the user specific
65 data.
66 .SH HOME
67 .sp
68 To find out more information please check:
69 \fI\%http://libmemcached.org/\fP
70 .SH SEE ALSO
71 .sp
72 memcached(1) libmemcached(3)
73 .SH AUTHOR
74 Brian Aker
75 .SH COPYRIGHT
76 2011, Brian Aker DataDifferential, http://datadifferential.com/
77 .\" Generated by docutils manpage writer.
78 .\"
79 .