X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_delete.rst;h=1c4f2661bd11e9a5b7145fdcae97ee6a043c5f5e;hb=ac46009041afe0134d3719e7ab6bc467d136ac0b;hp=acea40fafcd7de40f523cd48de891afb776fdae4;hpb=16ba6539e831e2abcef9dcf56fa26e3a0d5c7f91;p=awesomized%2Flibmemcached diff --git a/docs/memcached_delete.rst b/docs/memcached_delete.rst index acea40fa..1c4f2661 100644 --- a/docs/memcached_delete.rst +++ b/docs/memcached_delete.rst @@ -11,9 +11,9 @@ SYNOPSIS #include -.. 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 (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); +.. 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 @@ -22,8 +22,8 @@ DESCRIPTION ----------- -:c:func:`memcached_delete()` is used to delete a particular key. -:c:func:`memcached_delete_by_key()` works the same, but it takes a master key +:c:func:`memcached_delete` is used to delete a particular key. +:c:func:`memcached_delete_by_key` works the same, but it takes a master key to find the given value. Expiration works by placing the item into a delete queue, which means that @@ -42,7 +42,7 @@ RETURN A value of type :c:type:`memcached_return_t` is returned On success that value will be :c:type:`MEMCACHED_SUCCESS`. -Use :c:func:`memcached_strerror()` to translate this value to a printable +Use :c:func:`memcached_strerror` to translate this value to a printable string. If you are using the non-blocking mode of the library, success only