=head1 NAME
-memcached_delete
+memcached_delete - Delete a key
=head1 LIBRARY
=head1 SYNOPSIS
-#include <memcached.h>
+ #include <memcached.h>
-memcached_return memcached_delete(memcached_st *ptr, char *key, size_t key_length,
- time_t expiration);
+ memcached_return_t
+ memcached_delete (memcached_st *ptr,
+ const char *key, size_t key_length,
+ time_t expiration);
+
+ memcached_return_t
+ memcached_delete_by_key (memcached_st *ptr,
+ const char *master_key, size_t master_key_length,
+ const char *key, size_t key_length,
+ time_t expiration);
=head1 DESCRIPTION
-memcached_delete() is used to delete a particular key. An expiration value
-can be applied so that the key is deleted after a set number of seconds.
+memcached_delete() is used to delete a particular key.
+memcached_delete_by_key() works the same, but it takes a master key to
+find the given value.
+
+Expiration works by placing the item into a delete queue, which means that
+it won't possible to retrieve it by the "get" command, but "add" and
+"replace" command with this key will also fail (the "set" command will
+succeed, however). After the time passes, the item is finally deleted from server memory.
+
+Please note the the Danga memcached server removed support for expiration in
+the 1.4 version.
=head1 RETURN
-memcached_delete() returns memcached_return. The value on success will be MEMCACHED_SUCCESS. For all errors check with memcached_strerror().
-If you are using the non-blocking mode of the library, success only means
-that the message was queued for delivery.
+A value of type C<memcached_return_t> is returned
+On success that value will be C<MEMCACHED_SUCCESS>.
+Use memcached_strerror() to translate this value to a printable string.
+
+If you are using the non-blocking mode of the library, success only
+means that the message was queued for delivery.
=head1 HOME
-To find out more information please check: http://tangent.org/552/libmemcached.html
+To find out more information please check:
+L<https://launchpad.net/libmemcached>
=head1 AUTHOR
-Brian Aker, brian@tangent.org
+Brian Aker, E<lt>brian@tangent.orgE<gt>
=head1 SEE ALSO