X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Flibmemcached%2Fmemcached_fetch.rst;h=0d58d6163423ac2e26e697e1c759e7c0a4b22240;hb=a08ebebc7f7f2d86eb13151fb230cbfcd17dc090;hp=0e9378d9d9bc6f99856953f784cb7fe6a174f695;hpb=43032f572a83233b5183ed6989921efe930aa719;p=awesomized%2Flibmemcached diff --git a/docs/source/libmemcached/memcached_fetch.rst b/docs/source/libmemcached/memcached_fetch.rst index 0e9378d9..0d58d616 100644 --- a/docs/source/libmemcached/memcached_fetch.rst +++ b/docs/source/libmemcached/memcached_fetch.rst @@ -1,41 +1,52 @@ memcached_fetch ================= -.. index:: object: memcached_st - SYNOPSIS -------- #include + Compile and link with -lmemcached .. function:: char *memcached_fetch(memcached_st *ptr, char *key, size_t *key_length, size_t *value_length, uint32_t *flags, memcached_return_t *error) .. deprecated:: 0.50 Use :func:`memcached_fetch_result` instead. -Compile and link with -lmemcached DESCRIPTION ----------- -:func:`memcached_fetch` is used to fetch an individual value from the server. :func:`memcached_mget` must always be called before using this method. -You must pass in a key and its length to fetch the object. You must supply -three pointer variables which will give you the state of the returned -object. A :type:`uint32_t` pointer to contain whatever flags you stored with the value, a :type:`size_t` pointer which will be filled with size of of the -object, and a :type:`memcached_return_t` pointer to hold any error. The -object will be returned upon success and NULL will be returned on failure. `MEMCACHED_END` is returned by the \*error value when all objects that have been found are returned. The final value upon `MEMCACHED_END` is null. +:func:`memcached_fetch` is used to fetch an individual value from the server. +:func:`memcached_mget` must always be called before using this method. +You must pass in a key and its length to fetch the object. + +You must supply three pointer variables which will give you the state of the returned +object: + + * A :type:`uint32_t` pointer to contain whatever flags you stored with the value, + * a :type:`size_t` pointer which will be filled with size of of the object, and + * a :type:`memcached_return_t` pointer to hold any error. + +The object will be returned upon success and NULL will be returned on failure. + +`MEMCACHED_END` is returned by the error value when all objects that have been found are returned. +The final value upon `MEMCACHED_END` is a NULL pointer. Values returned by :func:`memcached_fetch` must be freed by the caller. All of the above functions are not tested when the `MEMCACHED_BEHAVIOR_USE_UDP` has been set. Executing any of these -functions with this behavior on will result in `MEMCACHED_NOT_SUPPORTED` being returned, or for those functions which do not return a :type:`memcached_return_t`, the error function parameter will be set to `MEMCACHED_NOT_SUPPORTED`. +functions with this behavior on will result in `MEMCACHED_NOT_SUPPORTED` +being returned, or for those functions which do not return a +:type:`memcached_return_t`, the error function parameter will +be set to `MEMCACHED_NOT_SUPPORTED`. -RETURN ------- +RETURN VALUE +------------ :func:`memcached_fetch` sets error to to `MEMCACHED_END` upon successful conclusion. + `MEMCACHED_NOTFOUND` will be return if no keys at all were found. `MEMCACHED_KEY_TOO_BIG` is set to error whenever :func:`memcached_fetch` was used @@ -47,5 +58,14 @@ SEE ALSO .. only:: man - :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_fetch_result(3)` + :manpage:`memcached(1)` + :manpage:`libmemcached(3)` + :manpage:`memcached_strerror(3)` + :manpage:`memcached_fetch_result(3)` + +.. only:: html + * :manpage:`memcached(1)` + * :doc:`../libmemcached` + * :doc:`memcached_strerror` + * :doc:`memcached_get`