X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Flibmemcached%2Fmemcached_fetch.rst;h=de40c64f8f494bede647bb77bf97c5927faeef56;hb=cfe08f8ecd0fd090430c417ac99999644041ba17;hp=9d9951016df549a9cced375b7be4abde03f1f7b8;hpb=7c12c89412585d136f8572f0ff3aee26427769de;p=awesomized%2Flibmemcached diff --git a/docs/libmemcached/memcached_fetch.rst b/docs/libmemcached/memcached_fetch.rst index 9d995101..de40c64f 100644 --- a/docs/libmemcached/memcached_fetch.rst +++ b/docs/libmemcached/memcached_fetch.rst @@ -1,5 +1,5 @@ ================= -memcached_fetch() +memcached_fetch ================= .. index:: object: memcached_st @@ -14,7 +14,7 @@ SYNOPSIS .. c: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 :c:func:`memcached_fetch_result()` instead. + Use :c:func:`memcached_fetch_result` instead. Compile and link with -lmemcached @@ -23,14 +23,14 @@ Compile and link with -lmemcached DESCRIPTION ----------- -:c:func:`memcached_fetch()` is used to fetch an individual value from the server. :c:func:`memcached_mget()` must always be called before using this method. +:c:func:`memcached_fetch` is used to fetch an individual value from the server. :c: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 :c:type:`uint32_t` pointer to contain whatever flags you stored with the value, a :c:type:`size_t` pointer which will be filled with size of of the object, and a :c:type:`memcached_return_t` pointer to hold any error. The -object will be returned upon success and NULL will be returned on failure. :c:type:`MEMCACHD_END` is returned by the \*error value when all objects that have been found are returned. The final value upon :c:type:`MEMCACHED_END` is null. +object will be returned upon success and NULL will be returned on failure. :c:type:`MEMCACHED_END` is returned by the \*error value when all objects that have been found are returned. The final value upon :c:type:`MEMCACHED_END` is null. -Values returned by :c:func:`memcached_fetch()` must be freed by the caller. +Values returned by :c:func:`memcached_fetch` must be freed by the caller. All of the above functions are not tested when the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` has been set. Executing any of these @@ -41,11 +41,11 @@ functions with this behavior on will result in :c:type:`MEMCACHED_NOT_SUPPORTED` RETURN ------ -:c:func:`memcached_fetch()` sets error to +:c:func:`memcached_fetch` sets error to to :c:type:`MEMCACHED_END` upon successful conclusion. :c:type:`MEMCACHED_NOTFOUND` will be return if no keys at all were found. -:c:type:`MEMCACHED_KEY_TOO_BIG` is set to error whenever :c::func:`memcached_fetch()` was used +:c:type:`MEMCACHED_KEY_TOO_BIG` is set to error whenever :c:func:`memcached_fetch` was used and the key was set larger then :c:type:`MEMCACHED_MAX_KEY`, which was the largest key allowed for the original memcached ascii server.