memcached_delete(3)

1memcached_delete.pop(3)        memcached_delete        memcached_delete.pop(3)
2
3
4

NAME

6       memcached_delete - Delete a key
7

LIBRARY

9       C Client Library for memcached (libmemcached, -lmemcached)
10

SYNOPSIS

12         #include <memcached.h>
13
14         memcached_return_t
15           memcached_delete (memcached_st *ptr,
16                             const char *key, size_t key_length,
17                             time_t expiration);
18
19         memcached_return_t
20         memcached_delete_by_key (memcached_st *ptr,
21                                  const char *master_key, size_t master_key_length,
22                                  const char *key, size_t key_length,
23                                  time_t expiration);
24

DESCRIPTION

26       memcached_delete() is used to delete a particular key.
27       memcached_delete_by_key() works the same, but it takes a master key to
28       find the given value.
29
30       Expiration works by placing the item into a delete queue, which means
31       that it won't possible to retrieve it by the "get" command, but "add"
32       and "replace" command with this key will also fail (the "set" command
33       will succeed, however). After the time passes, the item is finally
34       deleted from server memory.
35
36       Please note the the Danga memcached server removed support for
37       expiration in the 1.4 version.
38

RETURN

40       A value of type "memcached_return_t" is returned On success that value
41       will be "MEMCACHED_SUCCESS".  Use memcached_strerror() to translate
42       this value to a printable string.
43
44       If you are using the non-blocking mode of the library, success only
45       means that the message was queued for delivery.
46

HOME

48       To find out more information please check:
49       <https://launchpad.net/libmemcached>
50

AUTHOR

52       Brian Aker, <brian@tangent.org>
53