X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_delete.rst;h=6082094a23c43f88838f10df6dc2804b2e1beeec;hb=6e9731947eace4be83d553a242a44b36b3adcf22;hp=7c99276300dffd7a1007001fd228f385ad6c2fdb;hpb=49fc1e5ea4ea006f4a2ac71428833760f6fac030;p=m6w6%2Flibmemcached diff --git a/docs/memcached_delete.rst b/docs/memcached_delete.rst index 7c992763..6082094a 100644 --- a/docs/memcached_delete.rst +++ b/docs/memcached_delete.rst @@ -1,48 +1,23 @@ -.. highlight:: perl +=========================== +Deleting data from a server +=========================== - -**** -NAME -**** - - -memcached_delete - Delete a key - - -******* -LIBRARY -******* - - -C Client Library for memcached (libmemcached, -lmemcached) - - -******** +-------- SYNOPSIS -******** - - +-------- -.. code-block:: perl - #include +#include - 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); +.. c:function:: memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration); +.. c:function:: memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration); +Compile and link with -lmemcached -*********** +----------- DESCRIPTION -*********** +----------- memcached_delete() is used to delete a particular key. @@ -54,13 +29,13 @@ 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 +Please note the the Danga memcached server removed tests for expiration in the 1.4 version. -****** +------ RETURN -****** +------ A value of type \ ``memcached_return_t``\ is returned @@ -71,27 +46,25 @@ If you are using the non-blocking mode of the library, success only means that the message was queued for delivery. -**** +---- HOME -**** +---- To find out more information please check: `https://launchpad.net/libmemcached `_ -****** +------ AUTHOR -****** +------ Brian Aker, -******** +-------- SEE ALSO -******** - - -memcached(1) libmemcached(3) memcached_strerror(3) +-------- +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`