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

   1 =head1 NAME
   2
   3 memcached_delete - Delete a key
   4
   5 =head1 LIBRARY
   6
   7 C Client Library for memcached (libmemcached, -lmemcached)
   8
   9 =head1 SYNOPSIS
  10
  11   #include <memcached.h>
  12
  13   memcached_return_t
  14     memcached_delete (memcached_st *ptr,
  15                       const char *key, size_t key_length,
  16                       time_t expiration);
  17
  18   memcached_return_t
  19   memcached_delete_by_key (memcached_st *ptr,
  20                            const char *master_key, size_t master_key_length,
  21                            const char *key, size_t key_length,
  22                            time_t expiration);
  23
  24 =head1 DESCRIPTION
  25
  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 that
  31 it won't possible to retrieve it by the "get" command, but "add" and
  32 "replace" command with this key will also fail (the "set" command will
  33 succeed, however). After the time passes, the item is finally deleted from server memory.
  34
  35 Please note the the Danga memcached server removed support for expiration in
  36 the 1.4 version.
  37
  38 =head1 RETURN
  39
  40 A value of type C<memcached_return_t> is returned
  41 On success that value will be C<MEMCACHED_SUCCESS>.
  42 Use memcached_strerror() to translate 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
  47 =head1 HOME
  48
  49 To find out more information please check:
  50 L<https://launchpad.net/libmemcached>
  51
  52 =head1 AUTHOR
  53
  54 Brian Aker, E<lt>brian@tangent.orgE<gt>
  55
  56 =head1 SEE ALSO
  57
  58 memcached(1) libmemcached(3) memcached_strerror(3)
  59
  60 =cut
  61