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.
  28 memcached_delete_by_key() works the same, but it takes a master key to
  29 find the given value.
  30
  31 =head1 RETURN
  32
  33 A value of type C<memcached_return> is returned
  34 On success that value will be C<MEMCACHED_SUCCESS>.
  35 Use memcached_strerror() to translate this value to a printable string.
  36
  37 If you are using the non-blocking mode of the library, success only
  38 means that the message was queued for delivery.
  39
  40 =head1 HOME
  41
  42 To find out more information please check:
  43 L<http://tangent.org/552/libmemcached.html>
  44
  45 =head1 AUTHOR
  46
  47 Brian Aker, E<lt>brian@tangent.orgE<gt>
  48
  49 =head1 SEE ALSO
  50
  51 memcached(1) libmemcached(3) memcached_strerror(3)
  52
  53 =cut
  54