git.m6w6.name Git - awesomized/libmemcached/blob - docs/memcached_delete.rst

   1 ===========================
   2 Deleting data from a server
   3 ===========================
   4
   5 --------
   6 SYNOPSIS
   7 --------
   8
   9
  10 #include <libmemcached/memcached.h>
  11
  12 .. c:function:: memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration);
  13
  14 .. c:function:: memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration);
  15
  16 Compile and link with -lmemcached
  17
  18 -----------
  19 DESCRIPTION
  20 -----------
  21
  22
  23 memcached_delete() is used to delete a particular key.
  24 memcached_delete_by_key() works the same, but it takes a master key to
  25 find the given value.
  26
  27 Expiration works by placing the item into a delete queue, which means that
  28 it won't possible to retrieve it by the "get" command, but "add" and
  29 "replace" command with this key will also fail (the "set" command will
  30 succeed, however). After the time passes, the item is finally deleted from server memory.
  31
  32 Please note the the Danga memcached server removed tests for expiration in
  33 the 1.4 version.
  34
  35
  36 ------
  37 RETURN
  38 ------
  39
  40
  41 A value of type \ ``memcached_return_t``\  is returned
  42 On success that value will be \ ``MEMCACHED_SUCCESS``\ .
  43 Use memcached_strerror() to translate this value to a printable string.
  44
  45 If you are using the non-blocking mode of the library, success only
  46 means that the message was queued for delivery.
  47
  48
  49 ----
  50 HOME
  51 ----
  52
  53
  54 To find out more information please check:
  55 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
  56
  57
  58 ------
  59 AUTHOR
  60 ------
  61
  62
  63 Brian Aker, <brian@tangent.org>
  64
  65
  66 --------
  67 SEE ALSO
  68 --------
  69
  70 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`