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

   1 =head1 NAME
   2
   3 memcached_delete
   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                       char *key, size_t key_length,
  16                       time_t expiration);
  17
  18 =head1 DESCRIPTION
  19
  20 memcached_delete() is used to delete a particular key. An expiration value
  21 can be applied so that the key is deleted after that many seconds.
  22
  23 =head1 RETURN
  24
  25 A value of type C<memcached_return> is returned
  26 On success that value will be C<MEMCACHED_SUCCESS>.
  27 Use memcached_strerror() to translate this value to a printable string.
  28
  29 If you are using the non-blocking mode of the library, success only
  30 means that the message was queued for delivery.
  31
  32 =head1 HOME
  33
  34 To find out more information please check:
  35 L<http://tangent.org/552/libmemcached.html>
  36
  37 =head1 AUTHOR
  38
  39 Brian Aker, E<lt>brian@tangent.orgE<gt>
  40
  41 =head1 SEE ALSO
  42
  43 memcached(1) libmemcached(3) memcached_strerror(3)
  44
  45 =cut
  46