X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_delete.pod;h=89bff56a28bb05cf97b08a1e7403a8f384b333e9;hb=56bb95c23210147d45b792e4e494e995d9de76dc;hp=18fec84b4cb80c754577a1528e236abe122e1e44;hpb=2dce97932fbd574db1179add7bc3facc0318186c;p=awesomized%2Flibmemcached diff --git a/docs/memcached_delete.pod b/docs/memcached_delete.pod old mode 100755 new mode 100644 index 18fec84b..89bff56a --- a/docs/memcached_delete.pod +++ b/docs/memcached_delete.pod @@ -1,6 +1,6 @@ =head1 NAME -memcached_delete +memcached_delete - Delete a key =head1 LIBRARY @@ -10,27 +10,31 @@ C Client Library for memcached (libmemcached, -lmemcached) #include - memcached_return + memcached_return_t memcached_delete (memcached_st *ptr, - char *key, size_t key_length, + const char *key, size_t key_length, time_t expiration); - memcached_return + memcached_return_t memcached_delete_by_key (memcached_st *ptr, - char *master_key, size_t master_key_length, - char *key, size_t key_length, + 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 that many seconds. -memcached_delete_by_key() works the same, but it takes a master key to +can be applied so that the key is deleted after that many seconds, but this +will only work if you are using a 1.2.x server. If you are using a 1.2.x +server and you want to use the expiration value, please call memcached_version +one time for the memcached_st instance. If you don't do this no-reply and +buffered mode will be disabled to avoid getting out of sync with the server. +memcached_delete_by_key() works the same, but it takes a master key to find the given value. =head1 RETURN -A value of type C is returned +A value of type C is returned On success that value will be C. Use memcached_strerror() to translate this value to a printable string. @@ -40,7 +44,7 @@ means that the message was queued for delivery. =head1 HOME To find out more information please check: -L +L =head1 AUTHOR