Merge working tree with build tree.
[m6w6/libmemcached] / docs / man / memcached_user_data.3
1 .TH "MEMCACHED_USER_DATA" "3" "January 26, 2012" "1.0.4" "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 \fBmemcached_set_user_data()\fP is used to set the user specific data in the
55 \fBmemcached_st\fP structure.
56 .sp
57 \fBmemcached_get_user_data()\fP is used to retrieve the user specific data in the \fBmemcached_st\fP structure.
58 .SH RETURN
59 .sp
60 \fBmemcached_set_user_data()\fP returns the previous value of the user specific data.
61 .sp
62 \fBmemcached_get_user_data()\fP returns the current value uf the user specific data.
63 .SH HOME
64 .sp
65 To find out more information please check:
66 \fI\%http://libmemcached.org/\fP
67 .SH SEE ALSO
68 .sp
69 \fImemcached(1)\fP \fIlibmemcached(3)\fP
70 .SH AUTHOR
71 Brian Aker
72 .SH COPYRIGHT
73 2011, Brian Aker DataDifferential, http://datadifferential.com/
74 .\" Generated by docutils manpage writer.
75 .\"
76 .