X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;ds=inline;f=docs%2Fsource%2Flibmemcached%2Fmemcached_result_st.rst;h=fcc00abea293db54eb91ff3f94762959f06793f8;hb=0a654f848e13d470fb07b044347f2e91d6941807;hp=c0080b29673f31f79d8c7abb6009e88432c8a898;hpb=28c4d79e109e11d7d2a9f3189de57da28302ec68;p=awesomized%2Flibmemcached diff --git a/docs/source/libmemcached/memcached_result_st.rst b/docs/source/libmemcached/memcached_result_st.rst index c0080b29..fcc00abe 100644 --- a/docs/source/libmemcached/memcached_result_st.rst +++ b/docs/source/libmemcached/memcached_result_st.rst @@ -1,8 +1,6 @@ -======================== Working with result sets ======================== --------- SYNOPSIS -------- @@ -36,14 +34,10 @@ SYNOPSIS Compile and link with -lmemcachedutil -lmemcached - - ------------ DESCRIPTION ----------- - -libmemcached(3) can optionally return a :type:`memcached_result_st` which +libmemcached(3) can optionally return a :type:`memcached_result_st` which acts as a result object. The result objects have added benefits over the character pointer returns, in that they are forward compatible with new return items that future memcached servers may implement (the best current @@ -63,7 +57,7 @@ structure. If the structure was also allocated, it will deallocate it. :func:`memcached_result_key_value` returns the key value associated with the current result object. -:func:`memcached_result_key_length` returns the key length associated with +:func:`memcached_result_key_length` returns the key length associated with the current result object. :func:`memcached_result_value` returns the result value associated with the @@ -74,7 +68,7 @@ associated with the current result object. You must call free() to release this value, unless you have made use of a custom allocator. Use of a custom allocator requires that you create your own custom free() to release it. -:func:`memcached_result_length` returns the result length associated with +:func:`memcached_result_length` returns the result length associated with the current result object. :func:`memcached_result_flags` returns the flags associated with the @@ -98,19 +92,13 @@ You may wish to avoid using memcached_result_create(3) with a stack based allocation. The most common issues related to ABI safety involve heap allocated structures. - ------- -RETURN ------- - +RETURN VALUE +------------ Varies, see particular functions. All structures must have :func:`memcached_result_free` called on them for cleanup purposes. Failure to do this will result in leaked memory. - - --------- SEE ALSO --------