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.0.99 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 src="../_static/jquery.js"></script>
  25         <script src="../_static/underscore.js"></script>
  26         <script src="../_static/doctools.js"></script>
  27         <script 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="memcached_touch, memcached_touch_by_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.0
  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               <p class="caption"><span class="caption-text">libmemcached</span></p>
  89 <ul class="current">
  90 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  91 <li class="toctree-l1 current"><a class="reference internal" href="index.html">libmemcached API</a><ul class="current">
  92 <li class="toctree-l2"><a class="reference internal" href="index_basics.html">Basics</a></li>
  93 <li class="toctree-l2 current"><a class="reference internal" href="index_data.html">Working with Data</a></li>
  94 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
  95 <li class="toctree-l2"><a class="reference internal" href="index_advanced.html">Advanced Topics</a></li>
  96 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
  97 </ul>
  98 </li>
  99 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a><ul>
 100 <li class="toctree-l2"><a class="reference internal" href="configuration.html">Configuration</a></li>
 101 <li class="toctree-l2"><a class="reference internal" href="constants.html">Constants</a></li>
 102 <li class="toctree-l2"><a class="reference internal" href="examples.html">Examples</a></li>
 103 <li class="toctree-l2"><a class="reference internal" href="versioning.html">Versioning</a></li>
 104 </ul>
 105 </li>
 106 </ul>
 107 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 108 <ul>
 109 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
 110 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a><ul>
 111 <li class="toctree-l2"><a class="reference internal" href="../libmemcachedutil/memcached_pool.html">Working with memcached pools</a></li>
 112 </ul>
 113 </li>
 114 </ul>
 115 <p class="caption"><span class="caption-text">libhashkit</span></p>
 116 <ul>
 117 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
 118 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a><ul>
 119 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_create.html">Creating a hashkit structure</a></li>
 120 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_function.html">Set Hash Function</a></li>
 121 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_functions.html">Available Hashes</a></li>
 122 <li class="toctree-l2"><a class="reference internal" href="../libhashkit/hashkit_value.html">Generate hash value</a></li>
 123 </ul>
 124 </li>
 125 </ul>
 126 <p class="caption"><span class="caption-text">Client Applications</span></p>
 127 <ul>
 128 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a><ul>
 129 <li class="toctree-l2"><a class="reference internal" href="../bin/memcapable.html">memcapable - Checking a Memcached server capabilities and compatibility</a></li>
 130 <li class="toctree-l2"><a class="reference internal" href="../bin/memcat.html">memcat - “cat” data from a server</a></li>
 131 <li class="toctree-l2"><a class="reference internal" href="../bin/memcp.html">memcp - Copy data to a server</a></li>
 132 <li class="toctree-l2"><a class="reference internal" href="../bin/memdump.html">memdump - Dumping your server</a></li>
 133 <li class="toctree-l2"><a class="reference internal" href="../bin/memerror.html">memerror - translate an error code to a string</a></li>
 134 <li class="toctree-l2"><a class="reference internal" href="../bin/memflush.html">memflush - flush all data from a server</a></li>
 135 <li class="toctree-l2"><a class="reference internal" href="../bin/memrm.html">memrm - Remove data from a server</a></li>
 136 <li class="toctree-l2"><a class="reference internal" href="../bin/memslap.html">memslap - Load testing  and benchmarking a server</a></li>
 137 <li class="toctree-l2"><a class="reference internal" href="../bin/memaslap.html">memaslap - Load testing  and benchmarking a server</a></li>
 138 <li class="toctree-l2"><a class="reference internal" href="../bin/memstat.html">memstat - Gather statistics from a server</a></li>
 139 <li class="toctree-l2"><a class="reference internal" href="../bin/memexist.html">memexist - Check for the existence of a key</a></li>
 140 <li class="toctree-l2"><a class="reference internal" href="../bin/memparse.html">memparse - Parse an option string</a></li>
 141 <li class="toctree-l2"><a class="reference internal" href="../bin/memping.html">memping - Test to see if a server is available.</a></li>
 142 <li class="toctree-l2"><a class="reference internal" href="../bin/memtouch.html">memtouch - Touches a key.</a></li>
 143 </ul>
 144 </li>
 145 </ul>
 146
 147
 148
 149         </div>
 150       </div>
 151     </nav>
 152
 153     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 154
 155
 156       <nav class="wy-nav-top" aria-label="top navigation">
 157
 158           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 159           <a href="../index.html">libmemcached</a>
 160
 161       </nav>
 162
 163
 164       <div class="wy-nav-content">
 165
 166         <div class="rst-content">
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184 <div role="navigation" aria-label="breadcrumbs navigation">
 185
 186   <ul class="wy-breadcrumbs">
 187
 188       <li><a href="../index.html">Docs</a> &raquo;</li>
 189
 190           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 191
 192           <li><a href="index_data.html">Working with Data</a> &raquo;</li>
 193
 194       <li>Determine if a keys exists.</li>
 195
 196
 197       <li class="wy-breadcrumbs-aside">
 198
 199
 200
 201       </li>
 202
 203   </ul>
 204
 205
 206   <hr/>
 207 </div>
 208           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 209            <div itemprop="articleBody">
 210
 211   <div class="section" id="determine-if-a-keys-exists">
 212 <h1>Determine if a keys exists.<a class="headerlink" href="#determine-if-a-keys-exists" title="Permalink to this headline">¶</a></h1>
 213 <div class="section" id="synopsis">
 214 <span id="index-0"></span><h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 215 <p>#include &lt;libmemcached/memcached.h&gt;</p>
 216 <dl class="function">
 217 <dt id="_CPPv415memcached_existP12memcached_stPcP6size_t">
 218 <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="sig-name 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>
 219 <dd></dd></dl>
 220
 221 <dl class="function">
 222 <dt id="_CPPv422memcached_exist_by_keyP12memcached_stPcP6size_tPcP6size_t">
 223 <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="sig-name 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>
 224 <dd></dd></dl>
 225
 226 <p>Compile and link with -lmemcached</p>
 227 <div class="versionadded">
 228 <p><span class="versionmodified added">New in version 0.53.</span></p>
 229 </div>
 230 </div>
 231 <div class="section" id="description">
 232 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 233 <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>
 234 </div>
 235 <div class="section" id="return">
 236 <h2>RETURN<a class="headerlink" href="#return" title="Permalink to this headline">¶</a></h2>
 237 <dl class="simple">
 238 <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><dd><p>The key exists.</p>
 239 </dd>
 240 <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><dd><p>The key was not found.</p>
 241 </dd>
 242 </dl>
 243 </div>
 244 <div class="section" id="see-also">
 245 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 246 </div>
 247 </div>
 248
 249
 250            </div>
 251
 252           </div>
 253           <footer>
 254
 255     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 256
 257         <a href="memcached_touch.html" class="btn btn-neutral float-right" title="memcached_touch, memcached_touch_by_key" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 258
 259
 260         <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>
 261
 262     </div>
 263
 264
 265   <hr/>
 266
 267   <div role="contentinfo">
 268     <p>
 269         &copy; <a href="../copyright.html">Copyright</a>
 270
 271     </p>
 272   </div>
 273   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>.
 274
 275 </footer>
 276
 277         </div>
 278       </div>
 279
 280     </section>
 281
 282   </div>
 283
 284
 285
 286   <script type="text/javascript">
 287       jQuery(function () {
 288           SphinxRtdTheme.Navigation.enable(true);
 289       });
 290   </script>
 291
 292
 293
 294
 295
 296
 297 </body>
 298 </html>