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 memcached_delete(memcached_st *ptr, char *key, size_t key_length,
  14                                   time_t expiration);
  15
  16 =head1 DESCRIPTION
  17
  18 memcached_delete() is used to delete a particular key. An expiration value
  19 can be applied so that the key is deleted after a set number of seconds.
  20
  21 =head1 RETURN
  22
  23 memcached_delete() returns memcached_return. The value on success will be MEMCACHED_SUCCESS. For all errors check with memcached_strerror().
  24 If you are using the non-blocking mode of the library, success only means
  25 that the message was queued for delivery.
  26
  27 =head1 HOME
  28
  29 To find out more information please check: http://tangent.org/552/libmemcached.html
  30
  31 =head1 AUTHOR
  32
  33 Brian Aker, brian@tangent.org
  34
  35 =head1 SEE ALSO
  36
  37 memcached(1) libmemcached(3) memcached_strerror(3)
  38
  39 =cut
  40