git.m6w6.name Git - awesomized/libmemcached/blob - libmemcached/memcached_strerror.html

   1
   2
   3 <!DOCTYPE html>
   4 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
   5 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
   6 <head>
   7   <meta charset="utf-8">
   8
   9   <meta name="viewport" content="width=device-width, initial-scale=1.0">
  10
  11   <title>Converting Error Codes to Messages &mdash; libmemcached 1.1.0 documentation</title>
  12
  13
  14
  15
  16
  17
  18
  19
  20   <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
  21
  22
  23       <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  24         <script type="text/javascript" src="../_static/jquery.js"></script>
  25         <script type="text/javascript" src="../_static/underscore.js"></script>
  26         <script type="text/javascript" src="../_static/doctools.js"></script>
  27         <script type="text/javascript" src="../_static/language_data.js"></script>
  28
  29     <script type="text/javascript" src="../_static/js/theme.js"></script>
  30
  31
  32
  33
  34   <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  35   <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  36     <link rel="index" title="Index" href="../genindex.html" />
  37     <link rel="search" title="Search" href="../search.html" />
  38     <link rel="copyright" title="Copyright" href="../copyright.html" />
  39     <link rel="next" title="Advanced Topics" href="index_advanced.html" />
  40     <link rel="prev" title="Retrieving Error Codes and Messages" href="memcached_last_error.html" />
  41 </head>
  42
  43 <body class="wy-body-for-nav">
  44
  45
  46   <div class="wy-grid-for-nav">
  47
  48     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  49       <div class="wy-side-scroll">
  50         <div class="wy-side-nav-search" >
  51
  52
  53
  54             <a href="../index.html" class="icon icon-home"> libmemcached
  55
  56
  57
  58           </a>
  59
  60
  61
  62
  63               <div class="version">
  64                 1.1
  65               </div>
  66
  67
  68
  69
  70 <div role="search">
  71   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  72     <input type="text" name="q" placeholder="Search docs" />
  73     <input type="hidden" name="check_keywords" value="yes" />
  74     <input type="hidden" name="area" value="default" />
  75   </form>
  76 </div>
  77
  78
  79         </div>
  80
  81         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  82
  83
  84
  85
  86
  87
  88               <ul class="current">
  89 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  90 <li class="toctree-l1 current"><a class="reference internal" href="index.html">libmemcached API</a><ul class="current">
  91 <li class="toctree-l2"><a class="reference internal" href="index_basics.html">Basics</a></li>
  92 <li class="toctree-l2"><a class="reference internal" href="index_data.html">Working with Data</a></li>
  93 <li class="toctree-l2 current"><a class="reference internal" href="index_errors.html">Messages and Errors</a><ul class="current">
  94 <li class="toctree-l3"><a class="reference internal" href="memcached_return_t.html">Error Codes - memcached_return_t</a></li>
  95 <li class="toctree-l3"><a class="reference internal" href="memcached_last_error.html">Retrieving Error Codes and Messages</a></li>
  96 <li class="toctree-l3 current"><a class="current reference internal" href="#">Converting Error Codes to Messages</a></li>
  97 </ul>
  98 </li>
  99 <li class="toctree-l2"><a class="reference internal" href="index_advanced.html">Advanced Topics</a></li>
 100 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
 101 </ul>
 102 </li>
 103 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
 104 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
 105 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 106 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Miscellaneous</a></li>
 107 </ul>
 108 <ul>
 109 <li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
 110 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 111 </ul>
 112
 113
 114
 115         </div>
 116       </div>
 117     </nav>
 118
 119     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 120
 121
 122       <nav class="wy-nav-top" aria-label="top navigation">
 123
 124           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 125           <a href="../index.html">libmemcached</a>
 126
 127       </nav>
 128
 129
 130       <div class="wy-nav-content">
 131
 132         <div class="rst-content">
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150 <div role="navigation" aria-label="breadcrumbs navigation">
 151
 152   <ul class="wy-breadcrumbs">
 153
 154       <li><a href="../index.html">Docs</a> &raquo;</li>
 155
 156           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 157
 158           <li><a href="index_errors.html">Messages and Errors</a> &raquo;</li>
 159
 160       <li>Converting Error Codes to Messages</li>
 161
 162
 163       <li class="wy-breadcrumbs-aside">
 164
 165
 166
 167               <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libmemcached/memcached_strerror.rst" class="fa fa-github"> Edit on GitHub</a>
 168
 169
 170
 171       </li>
 172
 173   </ul>
 174
 175
 176   <hr/>
 177 </div>
 178           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 179            <div itemprop="articleBody">
 180
 181   <div class="section" id="converting-error-codes-to-messages">
 182 <h1>Converting Error Codes to Messages<a class="headerlink" href="#converting-error-codes-to-messages" title="Permalink to this headline">¶</a></h1>
 183 <div class="section" id="synopsis">
 184 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 185 <dl class="docutils">
 186 <dt>#include &lt;libmemcached/memcached.h&gt;</dt>
 187 <dd>Compile and link with -lmemcached</dd>
 188 </dl>
 189 <dl class="function">
 190 <dt id="_CPPv418memcached_strerrorP12memcached_st18memcached_return_t">
 191 <span id="_CPPv318memcached_strerrorP12memcached_st18memcached_return_t"></span><span id="_CPPv218memcached_strerrorP12memcached_st18memcached_return_t"></span><span id="memcached_strerror__memcached_stP.memcached_return_t"></span><em class="property">const</em> char *<code class="descname">memcached_strerror</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>, <a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <em>rc</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv418memcached_strerrorP12memcached_st18memcached_return_t" title="Permalink to this definition">¶</a><br /></dt>
 192 <dd><table class="docutils field-list" frame="void" rules="none">
 193 <col class="field-name" />
 194 <col class="field-body" />
 195 <tbody valign="top">
 196 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 197 <li><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</li>
 198 <li><strong>rc</strong> -- <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> value to query the string representation for</li>
 199 </ul>
 200 </td>
 201 </tr>
 202 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the string representation of <a class="reference internal" href="#_CPPv418memcached_strerrorP12memcached_st18memcached_return_t" title="memcached_strerror::rc"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">rc</span></code></a></p>
 203 </td>
 204 </tr>
 205 </tbody>
 206 </table>
 207 </dd></dl>
 208
 209 </div>
 210 <div class="section" id="description">
 211 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 212 <p><a class="reference internal" href="#_CPPv418memcached_strerrorP12memcached_st18memcached_return_t" title="memcached_strerror"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_strerror()</span></code></a> takes a <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> value and returns a string
 213 describing the error.</p>
 214 <p>This string must not be modified by the application.</p>
 215 <p><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> values are returned from nearly all libmemcached(3)
 216 functions.</p>
 217 <p><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> values are of an enum type so that you can set up responses
 218 with switch/case and know that you are capturing all possible return values.</p>
 219 </div>
 220 <div class="section" id="return-value">
 221 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 222 <p><a class="reference internal" href="#_CPPv418memcached_strerrorP12memcached_st18memcached_return_t" title="memcached_strerror"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_strerror()</span></code></a> returns a string describing a <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> value.</p>
 223 </div>
 224 <div class="section" id="see-also">
 225 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 226 <ul class="simple">
 227 <li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></li>
 228 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
 229 <li><a class="reference internal" href="memcached_return_t.html"><span class="doc">Error Codes - memcached_return_t</span></a></li>
 230 </ul>
 231 </div>
 232 </div>
 233
 234
 235            </div>
 236
 237           </div>
 238           <footer>
 239
 240     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 241
 242         <a href="index_advanced.html" class="btn btn-neutral float-right" title="Advanced Topics" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 243
 244
 245         <a href="memcached_last_error.html" class="btn btn-neutral float-left" title="Retrieving Error Codes and Messages" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 246
 247     </div>
 248
 249
 250   <hr/>
 251
 252   <div role="contentinfo">
 253     <p>
 254         &copy; <a href="../copyright.html">Copyright</a>
 255
 256     </p>
 257   </div>
 258   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>.
 259
 260 </footer>
 261
 262         </div>
 263       </div>
 264
 265     </section>
 266
 267   </div>
 268
 269
 270
 271   <script type="text/javascript">
 272       jQuery(function () {
 273           SphinxRtdTheme.Navigation.enable(true);
 274       });
 275   </script>
 276
 277
 278
 279
 280
 281
 282 </body>
 283 </html>