X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_delete.rst;h=1c4f2661bd11e9a5b7145fdcae97ee6a043c5f5e;hb=4e38a2eadb390c100cbc8e73bf257c49f6eeb7d8;hp=5c373b0847b7a0e9d68cc579faf808595e1acc44;hpb=a6c3e3a3d04f379b1480c8c88a8eae17e54b1449;p=m6w6%2Flibmemcached diff --git a/docs/memcached_delete.rst b/docs/memcached_delete.rst index 5c373b08..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,9 +22,9 @@ DESCRIPTION ----------- -memcached_delete() is used to delete a particular key. -memcached_delete_by_key() works the same, but it takes a master key to -find the given value. +: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 it won't be possible to retrieve it by the "get" command. The "add" and @@ -40,9 +40,10 @@ RETURN ------ -A value of type \ ``memcached_return_t``\ is returned -On success that value will be \ ``MEMCACHED_SUCCESS``\ . -Use memcached_strerror() to translate this value to a printable string. +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 +string. If you are using the non-blocking mode of the library, success only means that the message was queued for delivery.