X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_dump.rst;h=988410fc40fbdac1b57505962a75a2009845a3ab;hb=cecb14f06eebed8a17af796ea17b2850a89f18b5;hp=3ef1c43c0ec97decceaf425563678e4b9d1ef165;hpb=16ba6539e831e2abcef9dcf56fa26e3a0d5c7f91;p=m6w6%2Flibmemcached diff --git a/docs/memcached_dump.rst b/docs/memcached_dump.rst index 3ef1c43c..988410fc 100644 --- a/docs/memcached_dump.rst +++ b/docs/memcached_dump.rst @@ -15,9 +15,9 @@ SYNOPSIS #include -.. c:function:: memcached_return_t memcached_dump (memcached_st *ptr, memcached_dump_fn *function, void *context, uint32_t number_of_callbacks); +.. c:function:: memcached_return_t memcached_dump (memcached_st *ptr, memcached_dump_fn *function, void *context, uint32_t number_of_callbacks) -.. c:function:: typedef memcached_return_t (*memcached_dump_fn)(memcached_st *ptr, const char *key, size_t key_length, void *context); +.. c:type:: memcached_return_t (*memcached_dump_fn)(memcached_st *ptr, const char *key, size_t key_length, void *context) Compile and link with -lmemcached @@ -28,7 +28,7 @@ DESCRIPTION ----------- -:c:func:`memcached_dump()` is used to get a list of keys found in memcached(1) +:c:func:`memcached_dump` is used to get a list of keys found in memcached(1) servers. Because memcached(1) does not guarentee to dump all keys you can not assume you have fetched all keys from the server. The function takes an array of callbacks that it will use to execute on keys as they are found. @@ -43,7 +43,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.