jenkins-promote-staging-trunk-libmemcached-15
[awesomized/libmemcached] / docs / man / memcached_set_user_data.3
1 .TH "MEMCACHED_SET_USER_DATA" "3" "April 28, 2012" "1.0.7" "libmemcached"
2 .SH NAME
3 memcached_set_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
43 .ft P
44 .fi
45 .sp
46 #include <libmemcached/memcached.h>
47 .INDENT 0.0
48 .TP
49 .B void *memcached_get_user_data(memcached_st\fI\ *ptr\fP)
50 .UNINDENT
51 .INDENT 0.0
52 .TP
53 .B void *memcached_set_user_data(memcached_st\fI\ *ptr\fP, void\fI\ *data\fP)
54 .UNINDENT
55 .sp
56 Compile and link with \-lmemcached
57 .SH DESCRIPTION
58 .sp
59 libmemcached(3) allows you to store a pointer to a user specific data inside
60 the memcached_st structure.
61 .sp
62 \fI\%memcached_set_user_data()\fP is used to set the user specific data in the
63 \fBmemcached_st\fP structure.
64 .sp
65 \fI\%memcached_get_user_data()\fP is used to retrieve the user specific data in the \fBmemcached_st\fP structure.
66 .SH RETURN
67 .sp
68 \fI\%memcached_set_user_data()\fP returns the previous value of the user specific data.
69 .sp
70 \fI\%memcached_get_user_data()\fP returns the current value uf the user specific data.
71 .SH HOME
72 .sp
73 To find out more information please check:
74 \fI\%http://libmemcached.org/\fP
75 .SH SEE ALSO
76 .sp
77 \fImemcached(1)\fP \fIlibmemcached(3)\fP
78 .SH AUTHOR
79 Brian Aker
80 .SH COPYRIGHT
81 2011, Brian Aker DataDifferential, http://datadifferential.com/
82 .\" Generated by docutils manpage writer.
83 .\"
84 .