~piotr-sikora/libmemcached/fix-tests-on-openbsd

« back to all changes in this revision

Viewing changes to docs/man/memcached_user_data.3

Merge in all of build.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH "MEMCACHED_USER_DATA" "3" "April 09, 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
.SS 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
.SS 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\%https://launchpad.net/libmemcached\fP
 
70
.SH AUTHOR
 
71
.sp
 
72
Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
 
73
.SS SEE ALSO
 
74
.sp
 
75
memcached(1) libmemcached(3)
 
76
.SH AUTHOR
 
77
Brian Aker
 
78
.SH COPYRIGHT
 
79
2011, Brian Aker DataDifferential, http://datadifferential.com/
 
80
.\" Generated by docutils manpage writer.
 
81
.\" 
 
82
.