Merge of build trunk.
[awesomized/libmemcached] / docs / man / memcached_exist.3
1 .TH "MEMCACHED_EXIST" "3" "October 18, 2011" "1.01" "libmemcached"
2 .SH NAME
3 memcached_exist \- 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 .SH SYNOPSIS
34 .sp
35 #include <libmemcached/memcached.h>
36 .INDENT 0.0
37 .TP
38 .B memcached_return_t memcached_exist(memcached_st\fI\ *ptr\fP, char\fI\ *key\fP, size_t\fI\ *key_length\fP)
39 .UNINDENT
40 .INDENT 0.0
41 .TP
42 .B memcached_return_t memcached_exist_by_key(memcached_st\fI\ *ptr\fP, char\fI\ *group_key\fP, size_t\fI\ *group_key_length\fP, char\fI\ *key\fP, size_t\fI\ *key_length\fP)
43 .sp
44 New in version 0.53.
45 .UNINDENT
46 .sp
47 Compile and link with \-lmemcached
48 .SH DESCRIPTION
49 .sp
50 \fI\%memcached_exist()\fP can be used to check to see if a key exists. No value is returned if the key exists, or does not exist, on the server.
51 .SH RETURN
52 .sp
53 \fI\%memcached_exist()\fP sets error to
54 to \fBMEMCACHED_SUCCESS\fP upon finding that the key exists.
55 \fBMEMCACHED_NOTFOUND\fP will be return if the key is not found.
56 .SH HOME
57 .sp
58 To find out more information please check:
59 \fI\%http://libmemcached.org/\fP
60 .SH SEE ALSO
61 .sp
62 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
63 .SH AUTHOR
64 Brian Aker
65 .SH COPYRIGHT
66 2011, Brian Aker DataDifferential, http://datadifferential.com/
67 .\" Generated by docutils manpage writer.
68 .\"
69 .