git.m6w6.name Git - awesomized/libmemcached/blob - libmemcached/memcached_last_error.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>Retrieving Error Codes and 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="Converting Error Codes to Messages" href="memcached_strerror.html" />
  40     <link rel="prev" title="Error Codes - memcached_return_t" href="memcached_return_t.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 current"><a class="current reference internal" href="#">Retrieving Error Codes and Messages</a></li>
  96 <li class="toctree-l3"><a class="reference internal" href="memcached_strerror.html">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>Retrieving Error Codes and 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_last_error.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="retrieving-error-codes-and-messages">
 182 <h1>Retrieving Error Codes and Messages<a class="headerlink" href="#retrieving-error-codes-and-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="_CPPv420memcached_last_errorPK12memcached_st">
 191 <span id="_CPPv320memcached_last_errorPK12memcached_st"></span><span id="_CPPv220memcached_last_errorPK12memcached_st"></span><span id="memcached_last_error__memcached_stCP"></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_last_error</code><span class="sig-paren">(</span><em class="property">const</em> <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="#_CPPv420memcached_last_errorPK12memcached_st" 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"><strong>ptr</strong> -- pointer to an 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>
 197 </tr>
 198 <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 of last operation</td>
 199 </tr>
 200 </tbody>
 201 </table>
 202 </dd></dl>
 203
 204 <dl class="function">
 205 <dt id="_CPPv428memcached_last_error_messagePK12memcached_st">
 206 <span id="_CPPv328memcached_last_error_messagePK12memcached_st"></span><span id="_CPPv228memcached_last_error_messagePK12memcached_st"></span><span id="memcached_last_error_message__memcached_stCP"></span><em class="property">const</em> char *<code class="descname">memcached_last_error_message</code><span class="sig-paren">(</span><em class="property">const</em> <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="#_CPPv428memcached_last_error_messagePK12memcached_st" title="Permalink to this definition">¶</a><br /></dt>
 207 <dd><table class="docutils field-list" frame="void" rules="none">
 208 <col class="field-name" />
 209 <col class="field-body" />
 210 <tbody valign="top">
 211 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ptr</strong> -- pointer to an 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>
 212 </tr>
 213 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">message describing the status of last operation</td>
 214 </tr>
 215 </tbody>
 216 </table>
 217 </dd></dl>
 218
 219 <dl class="function">
 220 <dt id="_CPPv426memcached_last_error_errnoPK12memcached_st">
 221 <span id="_CPPv326memcached_last_error_errnoPK12memcached_st"></span><span id="_CPPv226memcached_last_error_errnoPK12memcached_st"></span><span id="memcached_last_error_errno__memcached_stCP"></span>int <code class="descname">memcached_last_error_errno</code><span class="sig-paren">(</span><em class="property">const</em> <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="#_CPPv426memcached_last_error_errnoPK12memcached_st" title="Permalink to this definition">¶</a><br /></dt>
 222 <dd><table class="docutils field-list" frame="void" rules="none">
 223 <col class="field-name" />
 224 <col class="field-body" />
 225 <tbody valign="top">
 226 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ptr</strong> -- pointer to an 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>
 227 </tr>
 228 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/3/errno">errno(3)</a></em> (if any) of last operation</td>
 229 </tr>
 230 </tbody>
 231 </table>
 232 </dd></dl>
 233
 234 </div>
 235 <div class="section" id="description">
 236 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 237 <p>Retrieve error codes and messages.</p>
 238 </div>
 239 <div class="section" id="return-value">
 240 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 241 <p><a class="reference internal" href="#_CPPv420memcached_last_errorPK12memcached_st" title="memcached_last_error"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_last_error()</span></code></a> returns the last error code.</p>
 242 <p><a class="reference internal" href="#_CPPv428memcached_last_error_messagePK12memcached_st" title="memcached_last_error_message"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_last_error_message()</span></code></a> returns the last error message. If this error
 243 came from a specific server, its hostname and port will be provided in the error
 244 message. Any error message will be returned as 'const char *' which does not
 245 need to be de-allocated. NULL will be returned if no error has occurred.</p>
 246 <p><a class="reference internal" href="#_CPPv426memcached_last_error_errnoPK12memcached_st" title="memcached_last_error_errno"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_last_error_errno()</span></code></a> returns any last local error code obtained from
 247 <em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/3/errno">errno(3)</a></em>.</p>
 248 </div>
 249 <div class="section" id="see-also">
 250 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 251 <ul class="simple">
 252 <li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></li>
 253 <li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/3/errno">errno(3)</a></em></li>
 254 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
 255 <li><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></li>
 256 </ul>
 257 </div>
 258 </div>
 259
 260
 261            </div>
 262
 263           </div>
 264           <footer>
 265
 266     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 267
 268         <a href="memcached_strerror.html" class="btn btn-neutral float-right" title="Converting Error Codes to Messages" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 269
 270
 271         <a href="memcached_return_t.html" class="btn btn-neutral float-left" title="Error Codes - memcached_return_t" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 272
 273     </div>
 274
 275
 276   <hr/>
 277
 278   <div role="contentinfo">
 279     <p>
 280         &copy; <a href="../copyright.html">Copyright</a>
 281
 282     </p>
 283   </div>
 284   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>.
 285
 286 </footer>
 287
 288         </div>
 289       </div>
 290
 291     </section>
 292
 293   </div>
 294
 295
 296
 297   <script type="text/javascript">
 298       jQuery(function () {
 299           SphinxRtdTheme.Navigation.enable(true);
 300       });
 301   </script>
 302
 303
 304
 305
 306
 307
 308 </body>
 309 </html>