X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Flibmemcached%2Fmemcached_fetch.rst;h=ae5677778dec6b5818fd77c860de743a92caeb74;hb=e20117720ca0fa133781b62c43aab59fe864b390;hp=4df61ab899f9c93c917c388c342ab0ad303ccc7a;hpb=28c4d79e109e11d7d2a9f3189de57da28302ec68;p=m6w6%2Flibmemcached diff --git a/docs/source/libmemcached/memcached_fetch.rst b/docs/source/libmemcached/memcached_fetch.rst index 4df61ab8..ae567777 100644 --- a/docs/source/libmemcached/memcached_fetch.rst +++ b/docs/source/libmemcached/memcached_fetch.rst @@ -1,16 +1,13 @@ -================= memcached_fetch ================= .. index:: object: memcached_st --------- SYNOPSIS -------- - #include - + .. 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 @@ -18,30 +15,26 @@ SYNOPSIS 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. +: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. -Values returned by :func:`memcached_fetch` must be freed by the caller. +Values returned by :func:`memcached_fetch` must be freed by the caller. -All of the above functions are not tested when the +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`. +RETURN VALUE +------------ ------- -RETURN ------- - -:func:`memcached_fetch` sets error to +:func:`memcached_fetch` sets error to to `MEMCACHED_END` upon successful conclusion. `MEMCACHED_NOTFOUND` will be return if no keys at all were found. @@ -49,8 +42,6 @@ to `MEMCACHED_END` upon successful conclusion. and the key was set larger then `MEMCACHED_MAX_KEY`, which was the largest key allowed for the original memcached ascii server. - --------- SEE ALSO --------