pushed the following commits:\
[m6w6/libmemcached] / libmemcached / memcached_version.html
index 63a634f4ecdeee6936ddb46f5d6025a50478ee08..1cb2f355439272744776c408b4671d803c32d848 100644 (file)
@@ -1,44 +1,43 @@
 
 
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
 <head>
   <meta charset="utf-8">
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Getting version information about the client and server &mdash; libmemcached 1.0.99 documentation</title>
+  <title>Getting version information &mdash; libmemcached 1.0.99 documentation</title>
   
 
   
-  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
-  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-
-  
   
   
   
 
   
-  <!--[if lt IE 9]>
-    <script src="../_static/js/html5shiv.min.js"></script>
-  <![endif]-->
+  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
   
     
       <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
-        <script src="../_static/jquery.js"></script>
-        <script src="../_static/underscore.js"></script>
-        <script src="../_static/doctools.js"></script>
-        <script src="../_static/language_data.js"></script>
+        <script type="text/javascript" src="../_static/jquery.js"></script>
+        <script type="text/javascript" src="../_static/underscore.js"></script>
+        <script type="text/javascript" src="../_static/doctools.js"></script>
+        <script type="text/javascript" src="../_static/language_data.js"></script>
     
     <script type="text/javascript" src="../_static/js/theme.js"></script>
 
     
+
+  
+  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
     <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="Statistics" href="index_advanced_stats.html" />
-    <link rel="prev" title="Setting the verbosity of a server" href="memcached_verbosity.html" /> 
+    <link rel="next" title="Deprecated Functionality" href="index_deprecated.html" />
+    <link rel="prev" title="Working with statistical information from a server" href="memcached_stats.html" /> 
 </head>
 
 <body class="wy-body-for-nav">
@@ -52,7 +51,7 @@
           
 
           
-            <a href="../index.html" class="icon icon-home" alt="Documentation Home"> libmemcached
+            <a href="../index.html" class="icon icon-home"> libmemcached
           
 
           
@@ -79,7 +78,6 @@
           
         </div>
 
-        
         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
           
             
 <li class="toctree-l3"><a class="reference internal" href="index_advanced_internals.html">Internal Behavior</a></li>
 <li class="toctree-l3"><a class="reference internal" href="index_advanced_aeh.html">Authentication, Encryption &amp; Hashing</a></li>
 <li class="toctree-l3"><a class="reference internal" href="index_advanced_servers.html">Servers and Server Lists</a></li>
-<li class="toctree-l3 current"><a class="reference internal" href="index_advanced_daemon.html">Affecting the memcached Daemon</a><ul class="current">
-<li class="toctree-l4"><a class="reference internal" href="memcached_dump.html">Dumping data from a server</a></li>
-<li class="toctree-l4"><a class="reference internal" href="memcached_flush.html">Wiping clean the contents of a server</a></li>
-<li class="toctree-l4"><a class="reference internal" href="memcached_verbosity.html">Setting the verbosity of a server</a></li>
-<li class="toctree-l4 current"><a class="current reference internal" href="#">Getting version information about the client and server</a></li>
+<li class="toctree-l3"><a class="reference internal" href="index_advanced_daemon.html">Affecting the memcached Daemon</a></li>
+<li class="toctree-l3 current"><a class="reference internal" href="index_advanced_stats.html">Statistics</a><ul class="current">
+<li class="toctree-l4"><a class="reference internal" href="memcached_analyze.html">Analyzing servers</a></li>
+<li class="toctree-l4"><a class="reference internal" href="memcached_stats.html">Working with statistical information from a server</a></li>
+<li class="toctree-l4 current"><a class="current reference internal" href="#">Getting version information</a></li>
 </ul>
 </li>
-<li class="toctree-l3"><a class="reference internal" href="index_advanced_stats.html">Statistics</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
             
           
         </div>
-        
       </div>
     </nav>
 
 
   <ul class="wy-breadcrumbs">
     
-      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
+      <li><a href="../index.html">Docs</a> &raquo;</li>
         
           <li><a href="index.html">libmemcached API</a> &raquo;</li>
         
           <li><a href="index_advanced.html">Advanced Topics</a> &raquo;</li>
         
-          <li><a href="index_advanced_daemon.html">Affecting the memcached Daemon</a> &raquo;</li>
+          <li><a href="index_advanced_stats.html">Statistics</a> &raquo;</li>
         
-      <li>Getting version information about the client and server</li>
+      <li>Getting version information</li>
     
     
       <li class="wy-breadcrumbs-aside">
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
             
-  <div class="section" id="getting-version-information-about-the-client-and-server">
-<h1>Getting version information about the client and server<a class="headerlink" href="#getting-version-information-about-the-client-and-server" title="Permalink to this headline">¶</a></h1>
+  <div class="section" id="getting-version-information">
+<h1>Getting version information<a class="headerlink" href="#getting-version-information" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="synopsis">
 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
-<p>#include &lt;libmemcached/memcached.h&gt;</p>
-<dl class="cpp function">
+<dl class="docutils">
+<dt>#include &lt;libmemcached/memcached.h&gt;</dt>
+<dd>Compile and link with -lmemcached</dd>
+</dl>
+<dl class="function">
 <dt id="_CPPv421memcached_lib_versionv">
-<span id="_CPPv321memcached_lib_versionv"></span><span id="_CPPv221memcached_lib_versionv"></span><span id="memcached_lib_version__void"></span><em class="property">const</em> char *<code class="sig-name descname">memcached_lib_version</code><span class="sig-paren">(</span>void<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv421memcached_lib_versionv" title="Permalink to this definition">¶</a><br /></dt>
-<dd></dd></dl>
-
-<dl class="cpp function">
+<span id="_CPPv321memcached_lib_versionv"></span><span id="_CPPv221memcached_lib_versionv"></span><span id="memcached_lib_version__void"></span><em class="property">const</em> char *<code class="descname">memcached_lib_version</code><span class="sig-paren">(</span>void<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv421memcached_lib_versionv" title="Permalink to this definition">¶</a><br /></dt>
+<dd><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">version string of <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code></td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
 <dt id="_CPPv417memcached_versionP12memcached_st">
-<span id="_CPPv317memcached_versionP12memcached_st"></span><span id="_CPPv217memcached_versionP12memcached_st"></span><span id="memcached_version__memcached_stP"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="sig-name descname">memcached_version</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417memcached_versionP12memcached_st" title="Permalink to this definition">¶</a><br /></dt>
-<dd></dd></dl>
+<span id="_CPPv317memcached_versionP12memcached_st"></span><span id="_CPPv217memcached_versionP12memcached_st"></span><span id="memcached_version__memcached_stP"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="descname">memcached_version</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417memcached_versionP12memcached_st" title="Permalink to this definition">¶</a><br /></dt>
+<dd><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ptr</strong> -- pointer to initialized <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> struct</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_return_t</span></code></a> indicating success</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 
-<p>Compile and link with -lmemcached</p>
 </div>
 <div class="section" id="description">
 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
-<p><a class="reference internal" href="#_CPPv421memcached_lib_versionv" title="memcached_lib_version"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_lib_version()</span></code></a> is used to return a simple version string representing the libmemcached version (client library version, not server version)</p>
-<p><a class="reference internal" href="#_CPPv417memcached_versionP12memcached_st" title="memcached_version"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_version()</span></code></a> is used to set the major, minor, and micro versions of each memcached server being used by the memcached_st connection structure. It returns the memcached server return code.</p>
+<p><a class="reference internal" href="#_CPPv421memcached_lib_versionv" title="memcached_lib_version"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_lib_version()</span></code></a> is used to return a simple version string
+representing the <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code> version (client library, not server).</p>
+<p><a class="reference internal" href="#_CPPv417memcached_versionP12memcached_st" title="memcached_version"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_version()</span></code></a> is used to set the major, minor, and micro versions of
+each memcached server being used by the <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_st</span></code></a> connection structure.
+It returns the memcached server return code.</p>
 </div>
 <div class="section" id="return-value">
 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
@@ -244,10 +263,10 @@ a printable string.</p>
   
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
       
-        <a href="index_advanced_stats.html" class="btn btn-neutral float-right" title="Statistics" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="index_deprecated.html" class="btn btn-neutral float-right" title="Deprecated Functionality" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
-        <a href="memcached_verbosity.html" class="btn btn-neutral float-left" title="Setting the verbosity of a server" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="memcached_stats.html" class="btn btn-neutral float-left" title="Working with statistical information from a server" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
       
     </div>
   
@@ -256,20 +275,11 @@ a printable string.</p>
 
   <div role="contentinfo">
     <p>
-        
-        
         &copy; <a href="../copyright.html">Copyright</a> 
 
     </p>
   </div>
-    
-    
-    
-    Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
-    
-    <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
-    
-    provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 
 
 </footer>
 
@@ -281,6 +291,7 @@ a printable string.</p>
   </div>
   
 
+
   <script type="text/javascript">
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);