git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached/memcached_exist.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>Determine if a keys exists &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="Update expiration on a key" href="memcached_touch.html" />
  40     <link rel="prev" title="Incrementing and Decrementing Values" href="memcached_auto.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 current"><a class="reference internal" href="index_data.html">Working with Data</a><ul class="current">
  93 <li class="toctree-l3"><a class="reference internal" href="memcached_auto.html">Incrementing and Decrementing Values</a></li>
  94 <li class="toctree-l3 current"><a class="current reference internal" href="#">Determine if a keys exists</a></li>
  95 <li class="toctree-l3"><a class="reference internal" href="memcached_touch.html">Update expiration on a key</a></li>
  96 <li class="toctree-l3"><a class="reference internal" href="memcached_flush_buffers.html">Flush and send buffered commands</a></li>
  97 <li class="toctree-l3"><a class="reference internal" href="memcached_result_st.html">Working with result sets</a></li>
  98 <li class="toctree-l3"><a class="reference internal" href="memcached_append.html">Appending or Prepending Data</a></li>
  99 <li class="toctree-l3"><a class="reference internal" href="memcached_cas.html">Working with data on the server in an atomic fashion</a></li>
 100 </ul>
 101 </li>
 102 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
 103 <li class="toctree-l2"><a class="reference internal" href="index_advanced.html">Advanced Topics</a></li>
 104 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
 105 </ul>
 106 </li>
 107 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
 108 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
 109 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 110 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Miscellaneous</a></li>
 111 </ul>
 112 <ul>
 113 <li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
 114 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 115 </ul>
 116
 117
 118
 119         </div>
 120       </div>
 121     </nav>
 122
 123     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 124
 125
 126       <nav class="wy-nav-top" aria-label="top navigation">
 127
 128           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 129           <a href="../index.html">libmemcached</a>
 130
 131       </nav>
 132
 133
 134       <div class="wy-nav-content">
 135
 136         <div class="rst-content">
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154 <div role="navigation" aria-label="breadcrumbs navigation">
 155
 156   <ul class="wy-breadcrumbs">
 157
 158       <li><a href="../index.html">Docs</a> &raquo;</li>
 159
 160           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 161
 162           <li><a href="index_data.html">Working with Data</a> &raquo;</li>
 163
 164       <li>Determine if a keys exists</li>
 165
 166
 167       <li class="wy-breadcrumbs-aside">
 168
 169
 170
 171               <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libmemcached/memcached_exist.rst" class="fa fa-github"> Edit on GitHub</a>
 172
 173
 174
 175       </li>
 176
 177   </ul>
 178
 179
 180   <hr/>
 181 </div>
 182           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 183            <div itemprop="articleBody">
 184
 185   <div class="section" id="determine-if-a-keys-exists">
 186 <h1>Determine if a keys exists<a class="headerlink" href="#determine-if-a-keys-exists" title="Permalink to this headline">¶</a></h1>
 187 <div class="section" id="synopsis">
 188 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 189 <dl class="docutils">
 190 <dt>#include &lt;libmemcached/memcached.h&gt;</dt>
 191 <dd>Compile and link with -lmemcached</dd>
 192 </dl>
 193 <dl class="function">
 194 <dt id="_CPPv415memcached_existP12memcached_stPcP6size_t">
 195 <span id="_CPPv315memcached_existP12memcached_stPcP6size_t"></span><span id="_CPPv215memcached_existP12memcached_stPcP6size_t"></span><span id="memcached_exist__memcached_stP.cP.sP"></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_exist</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>, char *<em>key</em>, size_t *<em>key_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415memcached_existP12memcached_stPcP6size_t" title="Permalink to this definition">¶</a><br /></dt>
 196 <dd></dd></dl>
 197
 198 <dl class="function">
 199 <dt id="_CPPv422memcached_exist_by_keyP12memcached_stPcP6size_tPcP6size_t">
 200 <span id="_CPPv322memcached_exist_by_keyP12memcached_stPcP6size_tPcP6size_t"></span><span id="_CPPv222memcached_exist_by_keyP12memcached_stPcP6size_tPcP6size_t"></span><span id="memcached_exist_by_key__memcached_stP.cP.sP.cP.sP"></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_exist_by_key</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>, char *<em>group_key</em>, size_t *<em>group_key_length</em>, char *<em>key</em>, size_t *<em>key_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422memcached_exist_by_keyP12memcached_stPcP6size_tPcP6size_t" title="Permalink to this definition">¶</a><br /></dt>
 201 <dd><table class="docutils field-list" frame="void" rules="none">
 202 <col class="field-name" />
 203 <col class="field-body" />
 204 <tbody valign="top">
 205 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 206 <li><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</li>
 207 <li><strong>group_key</strong> -- the key namespace</li>
 208 <li><strong>group_key_length</strong> -- length of the <a class="reference internal" href="#_CPPv422memcached_exist_by_keyP12memcached_stPcP6size_tPcP6size_t" title="memcached_exist_by_key::group_key"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">group_key</span></code></a> without any terminating zero</li>
 209 <li><strong>key</strong> -- the key to check</li>
 210 <li><strong>key_length</strong> -- length of the <a class="reference internal" href="#_CPPv422memcached_exist_by_keyP12memcached_stPcP6size_tPcP6size_t" title="memcached_exist_by_key::key"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">key</span></code></a> without any terminating zero</li>
 211 </ul>
 212 </td>
 213 </tr>
 214 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><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</p>
 215 </td>
 216 </tr>
 217 </tbody>
 218 </table>
 219 </dd></dl>
 220
 221 <div class="versionadded">
 222 <p><span class="versionmodified">New in version 0.53.</span></p>
 223 </div>
 224 </div>
 225 <div class="section" id="description">
 226 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 227 <p><a class="reference internal" href="#_CPPv415memcached_existP12memcached_stPcP6size_t" title="memcached_exist"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_exist()</span></code></a> can be used to check if a key exists.</p>
 228 </div>
 229 <div class="section" id="return-value">
 230 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 231 <dl class="docutils">
 232 <dt><a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t17MEMCACHED_SUCCESSE" title="MEMCACHED_SUCCESS"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_SUCCESS</span></code></a></dt>
 233 <dd>The key exists.</dd>
 234 <dt><a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t18MEMCACHED_NOTFOUNDE" title="MEMCACHED_NOTFOUND"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_NOTFOUND</span></code></a></dt>
 235 <dd>The key was not found.</dd>
 236 </dl>
 237 </div>
 238 <div class="section" id="see-also">
 239 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 240 <ul class="simple">
 241 <li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></li>
 242 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
 243 <li><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></li>
 244 </ul>
 245 </div>
 246 </div>
 247
 248
 249            </div>
 250
 251           </div>
 252           <footer>
 253
 254     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 255
 256         <a href="memcached_touch.html" class="btn btn-neutral float-right" title="Update expiration on a key" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 257
 258
 259         <a href="memcached_auto.html" class="btn btn-neutral float-left" title="Incrementing and Decrementing Values" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 260
 261     </div>
 262
 263
 264   <hr/>
 265
 266   <div role="contentinfo">
 267     <p>
 268         &copy; <a href="../copyright.html">Copyright</a>
 269
 270     </p>
 271   </div>
 272   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>.
 273
 274 </footer>
 275
 276         </div>
 277       </div>
 278
 279     </section>
 280
 281   </div>
 282
 283
 284
 285   <script type="text/javascript">
 286       jQuery(function () {
 287           SphinxRtdTheme.Navigation.enable(true);
 288       });
 289   </script>
 290
 291
 292
 293
 294
 295
 296 </body>
 297 </html>