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
  14     memcached_delete (memcached_st *ptr,
  15                       const char *key, size_t key_length,
  16                       time_t expiration);
  17
  18   memcached_return
  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. An expiration value
  27 can be applied so that the key is deleted after that many seconds, but this
  28 will only work if you are using a 1.2.x server. If you are using a 1.2.x
  29 server and you want to use the expiration value, please call memcached_version
  30 one time for the memcached_st instance. If you don't do this no-reply and
  31 buffered mode will be disabled to avoid getting out of sync with the server.
  32 memcached_delete_by_key() works the same, but it takes a master key to
  33 find the given value.
  34
  35 =head1 RETURN
  36
  37 A value of type C<memcached_return> is returned
  38 On success that value will be C<MEMCACHED_SUCCESS>.
  39 Use memcached_strerror() to translate this value to a printable string.
  40
  41 If you are using the non-blocking mode of the library, success only
  42 means that the message was queued for delivery.
  43
  44 =head1 HOME
  45
  46 To find out more information please check:
  47 L<http://tangent.org/552/libmemcached.html>
  48
  49 =head1 AUTHOR
  50
  51 Brian Aker, E<lt>brian@tangent.orgE<gt>
  52
  53 =head1 SEE ALSO
  54
  55 memcached(1) libmemcached(3) memcached_strerror(3)
  56
  57 =cut
  58