1MEMCACHED_DELETE(3)          libmemcached-awesome          MEMCACHED_DELETE(3)
2
3
4

NAME

6       memcached_delete - libmemcached Documentation
7

SYNOPSIS

9       #include <libmemcached/memcached.h>
10              Compile and link with -lmemcached
11
12       memcached_return_t memcached_delete(memcached_st *ptr, const char *key,
13       size_t key_length, time_t expiration)
14
15       memcached_return_t  memcached_delete_by_key(memcached_st  *ptr,   const
16       char  *group_key,  size_t  group_key_length,  const  char  *key, size_t
17       key_length, time_t expiration)
18
19              Parameters
20
21                     • ptr -- pointer to initialized memcached_st struct
22
23                     • group_key -- key namespace
24
25                     • group_key_length -- length of the group_key without any
26                       terminating zero
27
28                     • key -- the key to delete
29
30                     • key_length  -- the length og the key without any termi‐
31                       nating zero
32
33                     • expiration -- obsolete since memcached(1) version 1.4
34
35              Returns
36                     memcached_return_t indicating success
37

DESCRIPTION

39       memcached_delete()   is   used   to   delete    a    particular    key.
40       memcached_delete_by_key()  works the same, but it takes a master key to
41       find the given value.
42
43       Expiration works by placing the item into a delete queue,  which  means
44       that  it  won't  be  possible  to retrieve it by the "get" command. The
45       "add" and "replace" commands with this key will also  fail  (the  "set"
46       command will succeed, however).  After the time passes, the item is fi‐
47       nally deleted from server memory.
48
49       Please note the the memcached server removed tests  for  expiration  in
50       the 1.4 version.
51

RETURN VALUE

53       A  value  of  type memcached_return_t is returned On success that value
54       will be MEMCACHED_SUCCESS.  Use memcached_strerror() to translate  this
55       value to a printable string.
56
57       If  you  are  using  the non-blocking mode of the library, success only
58       means that the message was queued for delivery.
59

SEE ALSO

61       memcached(1) libmemcached(3) memcached_strerror(3)
62
63
64
65
661.1                              Feb 02, 2022              MEMCACHED_DELETE(3)
Impressum