Update docs.
[m6w6/libmemcached] / docs / man / memcached_delete.3
1 .TH "MEMCACHED_DELETE" "3" "April 09, 2011" "0.47" "libmemcached"
2 .SH NAME
3 memcached_delete \- 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 Delete a key
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 memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration);
45
46 memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *master_key, size_t master_key_length, const char *key, size_t key_length, time_t expiration);
47 .ft P
48 .fi
49 .SH DESCRIPTION
50 .sp
51 memcached_delete() is used to delete a particular key.
52 memcached_delete_by_key() works the same, but it takes a master key to
53 find the given value.
54 .sp
55 Expiration works by placing the item into a delete queue, which means that
56 it won\(aqt possible to retrieve it by the "get" command, but "add" and
57 "replace" command with this key will also fail (the "set" command will
58 succeed, however). After the time passes, the item is finally deleted from server memory.
59 .sp
60 Please note the the Danga memcached server removed tests for expiration in
61 the 1.4 version.
62 .SH RETURN
63 .sp
64 A value of type \fBmemcached_return_t\fP is returned
65 On success that value will be \fBMEMCACHED_SUCCESS\fP.
66 Use memcached_strerror() to translate this value to a printable string.
67 .sp
68 If you are using the non\-blocking mode of the library, success only
69 means that the message was queued for delivery.
70 .SH HOME
71 .sp
72 To find out more information please check:
73 \fI\%https://launchpad.net/libmemcached\fP
74 .SH AUTHOR
75 .sp
76 Brian Aker, <\fI\%brian@tangent.org\fP>
77 .SH SEE ALSO
78 .sp
79 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
80 .SH AUTHOR
81 Brian Aker
82 .SH COPYRIGHT
83 2011, Brian Aker DataDifferential, http://datadifferential.com/
84 .\" Generated by docutils manpage writer.
85 .\"
86 .