update docs
[m6w6/libmemcached] / libmemcached / memcached_result_st.html
index 9d27d7b008e071f1de69e8224eddbe068dd07186..6ca53f880c74516332eccb0bd735545cb066fde7 100644 (file)
@@ -36,7 +36,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="copyright" title="Copyright" href="../copyright.html" />
-    <link rel="next" title="Appending or Prepending to data on the server" href="memcached_append.html" />
+    <link rel="next" title="Appending or Prepending Data" href="memcached_append.html" />
     <link rel="prev" title="Flushing client buffers" href="memcached_flush_buffers.html" /> 
 </head>
 
 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="index.html">libmemcached API</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="index_basics.html">Basics</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="index_data.html">Working with Data</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index_data.html">Working with Data</a><ul class="current">
+<li class="toctree-l3"><a class="reference internal" href="memcached_auto.html">Incrementing and Decrementing Values</a></li>
+<li class="toctree-l3"><a class="reference internal" href="memcached_exist.html">Determine if a keys exists.</a></li>
+<li class="toctree-l3"><a class="reference internal" href="memcached_touch.html">memcached_touch, memcached_touch_by_key</a></li>
+<li class="toctree-l3"><a class="reference internal" href="memcached_flush_buffers.html">Flushing client buffers</a></li>
+<li class="toctree-l3 current"><a class="current reference internal" href="#">Working with result sets</a></li>
+<li class="toctree-l3"><a class="reference internal" href="memcached_append.html">Appending or Prepending Data</a></li>
+<li class="toctree-l3"><a class="reference internal" href="memcached_cas.html">Working with data on the server in an atomic fashion</a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
 <li class="toctree-l2"><a class="reference internal" href="index_advanced.html">Advanced Topics</a></li>
 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="configuration.html">Configuration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="constants.html">Constants</a></li>
-<li class="toctree-l2"><a class="reference internal" href="examples.html">Examples</a></li>
-<li class="toctree-l2"><a class="reference internal" href="versioning.html">Versioning</a></li>
-</ul>
-</li>
+<li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a></li>
 </ul>
 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcachedutil/memcached_pool.html">Working with memcached pools</a></li>
-</ul>
-</li>
+<li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
 </ul>
 <p class="caption"><span class="caption-text">libhashkit</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_create.html">Creating a hashkit structure</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_function.html">Set Hash Function</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_functions.html">Available Hashes</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_value.html">Generate hash value</a></li>
-</ul>
-</li>
+<li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
 </ul>
 <p class="caption"><span class="caption-text">Client Applications</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memcapable.html">memcapable - Checking a Memcached server capabilities and compatibility</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memcat.html">memcat - “cat” data from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memcp.html">memcp - Copy data to a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memdump.html">memdump - Dumping your server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memerror.html">memerror - translate an error code to a string</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memflush.html">memflush - flush all data from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memrm.html">memrm - Remove data from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memslap.html">memslap - Load testing  and benchmarking a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memaslap.html">memaslap - Load testing  and benchmarking a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memstat.html">memstat - Gather statistics from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memexist.html">memexist - Check for the existence of a key</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memparse.html">memparse - Parse an option string</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memping.html">memping - Test to see if a server is available.</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memtouch.html">memtouch - Touches a key.</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 </ul>
-</li>
+<p class="caption"><span class="caption-text">Copyright</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 </ul>
 
             
@@ -323,8 +305,8 @@ triggers).</p>
 stack based allocation. The most common issues related to ABI safety involve
 heap allocated structures.</p>
 </div>
-<div class="section" id="return">
-<h2>RETURN<a class="headerlink" href="#return" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="return-value">
+<h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 <p>Varies, see particular functions. All structures must have
 <a class="reference internal" href="#_CPPv421memcached_result_freeP19memcached_result_st" title="memcached_result_free"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_result_free()</span></code></a> called on them for cleanup purposes. Failure
 to do this will result in leaked memory.</p>
@@ -342,7 +324,7 @@ to do this will result in leaked memory.</p>
   
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
       
-        <a href="memcached_append.html" class="btn btn-neutral float-right" title="Appending or Prepending to data on the server" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="memcached_append.html" class="btn btn-neutral float-right" title="Appending or Prepending Data" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
         <a href="memcached_flush_buffers.html" class="btn btn-neutral float-left" title="Flushing client buffers" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>