X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Flibmemcached%2Fmemcached_delete.rst;h=767e01b43e96465aa9043c4bb42d3f24f16fe3e9;hb=90bb4fb5810353d35ce5575caa3b0a2139e3f4a1;hp=8c67e15d501235e6c60214c02518e2652fd4a8d5;hpb=28c4d79e109e11d7d2a9f3189de57da28302ec68;p=m6w6%2Flibmemcached diff --git a/docs/source/libmemcached/memcached_delete.rst b/docs/source/libmemcached/memcached_delete.rst index 8c67e15d..767e01b4 100644 --- a/docs/source/libmemcached/memcached_delete.rst +++ b/docs/source/libmemcached/memcached_delete.rst @@ -1,28 +1,23 @@ -=========================== Deleting data from a server =========================== .. index:: object: memcached_st --------- SYNOPSIS -------- - #include - + .. function:: memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration) .. 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 ----------- - -:func:`memcached_delete` is used to delete a particular key. +:func:`memcached_delete` is used to delete a particular key. :func:`memcached_delete_by_key` works the same, but it takes a master key to find the given value. @@ -34,12 +29,9 @@ succeed, however). After the time passes, the item is finally deleted from serve Please note the the memcached server removed tests for expiration in the 1.4 version. - ------- RETURN ------ - A value of type :type:`memcached_return_t` is returned On success that value will be `MEMCACHED_SUCCESS`. Use :func:`memcached_strerror` to translate this value to a printable @@ -48,9 +40,6 @@ string. If you are using the non-blocking mode of the library, success only means that the message was queued for delivery. - - --------- SEE ALSO --------