git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached/memcached_result_st.html

   1
   2
   3 <!DOCTYPE html>
   4 <html class="writer-html5" lang="en" >
   5 <head>
   6   <meta charset="utf-8">
   7
   8   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   9
  10   <title>Working with result sets &mdash; libmemcached 1.0.99 documentation</title>
  11
  12
  13
  14   <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  15   <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  16
  17
  18
  19
  20
  21
  22
  23   <!--[if lt IE 9]>
  24     <script src="../_static/js/html5shiv.min.js"></script>
  25   <![endif]-->
  26
  27
  28       <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  29         <script src="../_static/jquery.js"></script>
  30         <script src="../_static/underscore.js"></script>
  31         <script src="../_static/doctools.js"></script>
  32         <script src="../_static/language_data.js"></script>
  33
  34     <script type="text/javascript" src="../_static/js/theme.js"></script>
  35
  36
  37     <link rel="index" title="Index" href="../genindex.html" />
  38     <link rel="search" title="Search" href="../search.html" />
  39     <link rel="copyright" title="Copyright" href="../copyright.html" />
  40     <link rel="next" title="Appending or Prepending Data" href="memcached_append.html" />
  41     <link rel="prev" title="Flush and send buffered commands" href="memcached_flush_buffers.html" />
  42 </head>
  43
  44 <body class="wy-body-for-nav">
  45
  46
  47   <div class="wy-grid-for-nav">
  48
  49     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  50       <div class="wy-side-scroll">
  51         <div class="wy-side-nav-search" >
  52
  53
  54
  55             <a href="../index.html" class="icon icon-home" alt="Documentation Home"> libmemcached
  56
  57
  58
  59           </a>
  60
  61
  62
  63
  64               <div class="version">
  65                 1.0
  66               </div>
  67
  68
  69
  70
  71 <div role="search">
  72   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  73     <input type="text" name="q" placeholder="Search docs" />
  74     <input type="hidden" name="check_keywords" value="yes" />
  75     <input type="hidden" name="area" value="default" />
  76   </form>
  77 </div>
  78
  79
  80         </div>
  81
  82
  83         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  84
  85
  86
  87
  88
  89
  90               <p class="caption"><span class="caption-text">libmemcached</span></p>
  91 <ul class="current">
  92 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  93 <li class="toctree-l1 current"><a class="reference internal" href="index.html">libmemcached API</a><ul class="current">
  94 <li class="toctree-l2"><a class="reference internal" href="index_basics.html">Basics</a></li>
  95 <li class="toctree-l2 current"><a class="reference internal" href="index_data.html">Working with Data</a><ul class="current">
  96 <li class="toctree-l3"><a class="reference internal" href="memcached_auto.html">Incrementing and Decrementing Values</a></li>
  97 <li class="toctree-l3"><a class="reference internal" href="memcached_exist.html">Determine if a keys exists</a></li>
  98 <li class="toctree-l3"><a class="reference internal" href="memcached_touch.html">Update expiration on a key</a></li>
  99 <li class="toctree-l3"><a class="reference internal" href="memcached_flush_buffers.html">Flush and send buffered commands</a></li>
 100 <li class="toctree-l3 current"><a class="current reference internal" href="#">Working with result sets</a></li>
 101 <li class="toctree-l3"><a class="reference internal" href="memcached_append.html">Appending or Prepending Data</a></li>
 102 <li class="toctree-l3"><a class="reference internal" href="memcached_cas.html">Working with data on the server in an atomic fashion</a></li>
 103 </ul>
 104 </li>
 105 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
 106 <li class="toctree-l2"><a class="reference internal" href="index_advanced.html">Advanced Topics</a></li>
 107 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
 108 </ul>
 109 </li>
 110 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a></li>
 111 </ul>
 112 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 113 <ul>
 114 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
 115 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
 116 </ul>
 117 <p class="caption"><span class="caption-text">libhashkit</span></p>
 118 <ul>
 119 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
 120 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
 121 </ul>
 122 <p class="caption"><span class="caption-text">Client Applications</span></p>
 123 <ul>
 124 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 125 </ul>
 126 <p class="caption"><span class="caption-text">Copyright</span></p>
 127 <ul>
 128 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 129 </ul>
 130
 131
 132
 133         </div>
 134
 135       </div>
 136     </nav>
 137
 138     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 139
 140
 141       <nav class="wy-nav-top" aria-label="top navigation">
 142
 143           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 144           <a href="../index.html">libmemcached</a>
 145
 146       </nav>
 147
 148
 149       <div class="wy-nav-content">
 150
 151         <div class="rst-content">
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169 <div role="navigation" aria-label="breadcrumbs navigation">
 170
 171   <ul class="wy-breadcrumbs">
 172
 173       <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
 174
 175           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 176
 177           <li><a href="index_data.html">Working with Data</a> &raquo;</li>
 178
 179       <li>Working with result sets</li>
 180
 181
 182       <li class="wy-breadcrumbs-aside">
 183
 184
 185
 186       </li>
 187
 188   </ul>
 189
 190
 191   <hr/>
 192 </div>
 193           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 194            <div itemprop="articleBody">
 195
 196   <div class="section" id="working-with-result-sets">
 197 <h1>Working with result sets<a class="headerlink" href="#working-with-result-sets" title="Permalink to this headline">¶</a></h1>
 198 <div class="section" id="synopsis">
 199 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 200 <dl class="simple">
 201 <dt>#include &lt;libmemcached/memcached.h&gt;</dt><dd><p>Compile and link with -lmemcachedutil -lmemcached</p>
 202 </dd>
 203 </dl>
 204 <dl class="cpp type">
 205 <dt id="_CPPv419memcached_result_st">
 206 <span id="_CPPv319memcached_result_st"></span><span id="_CPPv219memcached_result_st"></span><span id="memcached_result_st"></span><em class="property">typedef </em><em class="property">struct</em> <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st">memcached_result_st</a> <code class="sig-name descname">memcached_result_st</code><a class="headerlink" href="#_CPPv419memcached_result_st" title="Permalink to this definition">¶</a><br /></dt>
 207 <dd></dd></dl>
 208
 209 <dl class="cpp function">
 210 <dt id="_CPPv423memcached_result_createP12memcached_stP19memcached_result_st">
 211 <span id="_CPPv323memcached_result_createP12memcached_stP19memcached_result_st"></span><span id="_CPPv223memcached_result_createP12memcached_stP19memcached_result_st"></span><span id="memcached_result_create__memcached_stP.memcached_result_stP"></span><a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st">memcached_result_st</a> *<code class="sig-name descname">memcached_result_create</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="#_CPPv419memcached_result_st" title="memcached_result_st">memcached_result_st</a> *<em>result</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv423memcached_result_createP12memcached_stP19memcached_result_st" title="Permalink to this definition">¶</a><br /></dt>
 212 <dd><dl class="field-list simple">
 213 <dt class="field-odd">Parameters</dt>
 214 <dd class="field-odd"><ul class="simple">
 215 <li><p><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</p></li>
 216 <li><p><strong>result</strong> -- pointer to an <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_result_st</span></code></a> instance to initialize or
 217 nullptr to allocate a new instance</p></li>
 218 </ul>
 219 </dd>
 220 <dt class="field-even">Returns</dt>
 221 <dd class="field-even"><p>pointer to initialized <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_result_st</span></code></a> instance</p>
 222 </dd>
 223 </dl>
 224 </dd></dl>
 225
 226 <dl class="cpp function">
 227 <dt id="_CPPv421memcached_result_freeP19memcached_result_st">
 228 <span id="_CPPv321memcached_result_freeP19memcached_result_st"></span><span id="_CPPv221memcached_result_freeP19memcached_result_st"></span><span id="memcached_result_free__memcached_result_stP"></span>void <code class="sig-name descname">memcached_result_free</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st">memcached_result_st</a> *<em>result</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv421memcached_result_freeP19memcached_result_st" title="Permalink to this definition">¶</a><br /></dt>
 229 <dd><dl class="field-list simple">
 230 <dt class="field-odd">Parameters</dt>
 231 <dd class="field-odd"><p><strong>result</strong> -- pointer to initialized <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_result_st</span></code></a> struct</p>
 232 </dd>
 233 </dl>
 234 </dd></dl>
 235
 236 <dl class="cpp function">
 237 <dt id="_CPPv426memcached_result_key_valueP19memcached_result_st">
 238 <span id="_CPPv326memcached_result_key_valueP19memcached_result_st"></span><span id="_CPPv226memcached_result_key_valueP19memcached_result_st"></span><span id="memcached_result_key_value__memcached_result_stP"></span><em class="property">const</em> char *<code class="sig-name descname">memcached_result_key_value</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st">memcached_result_st</a> *<em>result</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv426memcached_result_key_valueP19memcached_result_st" title="Permalink to this definition">¶</a><br /></dt>
 239 <dd><dl class="field-list simple">
 240 <dt class="field-odd">Parameters</dt>
 241 <dd class="field-odd"><p><strong>result</strong> -- pointer to initialized <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_result_st</span></code></a> struct</p>
 242 </dd>
 243 <dt class="field-even">Returns</dt>
 244 <dd class="field-even"><p>the key value associated with the current result object</p>
 245 </dd>
 246 </dl>
 247 </dd></dl>
 248
 249 <dl class="cpp function">
 250 <dt id="_CPPv427memcached_result_key_lengthPK19memcached_result_st">
 251 <span id="_CPPv327memcached_result_key_lengthPK19memcached_result_st"></span><span id="_CPPv227memcached_result_key_lengthPK19memcached_result_st"></span><span id="memcached_result_key_length__memcached_result_stCP"></span>size_t <code class="sig-name descname">memcached_result_key_length</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st">memcached_result_st</a> *<em>result</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv427memcached_result_key_lengthPK19memcached_result_st" title="Permalink to this definition">¶</a><br /></dt>
 252 <dd><dl class="field-list simple">
 253 <dt class="field-odd">Parameters</dt>
 254 <dd class="field-odd"><p><strong>result</strong> -- pointer to initialized <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_result_st</span></code></a> struct</p>
 255 </dd>
 256 <dt class="field-even">Returns</dt>
 257 <dd class="field-even"><p>the key length associated with the current result object</p>
 258 </dd>
 259 </dl>
 260 </dd></dl>
 261
 262 <dl class="cpp function">
 263 <dt id="_CPPv422memcached_result_valueP19memcached_result_st">
 264 <span id="_CPPv322memcached_result_valueP19memcached_result_st"></span><span id="_CPPv222memcached_result_valueP19memcached_result_st"></span><span id="memcached_result_value__memcached_result_stP"></span><em class="property">const</em> char *<code class="sig-name descname">memcached_result_value</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st">memcached_result_st</a> *<em>result</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422memcached_result_valueP19memcached_result_st" title="Permalink to this definition">¶</a><br /></dt>
 265 <dd><dl class="field-list simple">
 266 <dt class="field-odd">Parameters</dt>
 267 <dd class="field-odd"><p><strong>result</strong> -- pointer to initialized <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_result_st</span></code></a> struct</p>
 268 </dd>
 269 <dt class="field-even">Returns</dt>
 270 <dd class="field-even"><p>the result value associated with the current result object</p>
 271 </dd>
 272 </dl>
 273 </dd></dl>
 274
 275 <dl class="cpp function">
 276 <dt id="_CPPv427memcached_result_take_valueP19memcached_result_st">
 277 <span id="_CPPv327memcached_result_take_valueP19memcached_result_st"></span><span id="_CPPv227memcached_result_take_valueP19memcached_result_st"></span><span id="memcached_result_take_value__memcached_result_stP"></span>char *<code class="sig-name descname">memcached_result_take_value</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st">memcached_result_st</a> *<em>result</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv427memcached_result_take_valueP19memcached_result_st" title="Permalink to this definition">¶</a><br /></dt>
 278 <dd><dl class="field-list simple">
 279 <dt class="field-odd">Parameters</dt>
 280 <dd class="field-odd"><p><strong>result</strong> -- pointer to initialized <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_result_st</span></code></a> struct</p>
 281 </dd>
 282 <dt class="field-even">Returns</dt>
 283 <dd class="field-even"><p>the result value associated with the current result object</p>
 284 </dd>
 285 </dl>
 286 </dd></dl>
 287
 288 <dl class="cpp function">
 289 <dt id="_CPPv423memcached_result_lengthPK19memcached_result_st">
 290 <span id="_CPPv323memcached_result_lengthPK19memcached_result_st"></span><span id="_CPPv223memcached_result_lengthPK19memcached_result_st"></span><span id="memcached_result_length__memcached_result_stCP"></span>size_t <code class="sig-name descname">memcached_result_length</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st">memcached_result_st</a> *<em>result</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv423memcached_result_lengthPK19memcached_result_st" title="Permalink to this definition">¶</a><br /></dt>
 291 <dd><dl class="field-list simple">
 292 <dt class="field-odd">Parameters</dt>
 293 <dd class="field-odd"><p><strong>result</strong> -- pointer to initialized <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_result_st</span></code></a> struct</p>
 294 </dd>
 295 <dt class="field-even">Returns</dt>
 296 <dd class="field-even"><p>the result length associated with the current result object</p>
 297 </dd>
 298 </dl>
 299 </dd></dl>
 300
 301 <dl class="cpp function">
 302 <dt id="_CPPv422memcached_result_flagsPK19memcached_result_st">
 303 <span id="_CPPv322memcached_result_flagsPK19memcached_result_st"></span><span id="_CPPv222memcached_result_flagsPK19memcached_result_st"></span><span id="memcached_result_flags__memcached_result_stCP"></span>uint32_t <code class="sig-name descname">memcached_result_flags</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st">memcached_result_st</a> *<em>result</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422memcached_result_flagsPK19memcached_result_st" title="Permalink to this definition">¶</a><br /></dt>
 304 <dd><dl class="field-list simple">
 305 <dt class="field-odd">Parameters</dt>
 306 <dd class="field-odd"><p><strong>result</strong> -- pointer to initialized <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_result_st</span></code></a> struct</p>
 307 </dd>
 308 <dt class="field-even">Returns</dt>
 309 <dd class="field-even"><p>the flags associated with the current result object</p>
 310 </dd>
 311 </dl>
 312 </dd></dl>
 313
 314 <dl class="cpp function">
 315 <dt id="_CPPv420memcached_result_casPK19memcached_result_st">
 316 <span id="_CPPv320memcached_result_casPK19memcached_result_st"></span><span id="_CPPv220memcached_result_casPK19memcached_result_st"></span><span id="memcached_result_cas__memcached_result_stCP"></span>uint64_t <code class="sig-name descname">memcached_result_cas</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st">memcached_result_st</a> *<em>result</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv420memcached_result_casPK19memcached_result_st" title="Permalink to this definition">¶</a><br /></dt>
 317 <dd><dl class="field-list simple">
 318 <dt class="field-odd">Parameters</dt>
 319 <dd class="field-odd"><p><strong>result</strong> -- pointer to initialized <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_result_st</span></code></a> struct</p>
 320 </dd>
 321 <dt class="field-even">Returns</dt>
 322 <dd class="field-even"><p>the cas associated with the current result object</p>
 323 </dd>
 324 </dl>
 325 </dd></dl>
 326
 327 <dl class="cpp function">
 328 <dt id="_CPPv426memcached_result_set_valueP19memcached_result_stPKc6size_t">
 329 <span id="_CPPv326memcached_result_set_valueP19memcached_result_stPKc6size_t"></span><span id="_CPPv226memcached_result_set_valueP19memcached_result_stPKc6size_t"></span><span id="memcached_result_set_value__memcached_result_stP.cCP.s"></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_result_set_value</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st">memcached_result_st</a> *<em>result</em>, <em class="property">const</em> char *<em>value</em>, size_t <em>length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv426memcached_result_set_valueP19memcached_result_stPKc6size_t" title="Permalink to this definition">¶</a><br /></dt>
 330 <dd><dl class="field-list simple">
 331 <dt class="field-odd">Parameters</dt>
 332 <dd class="field-odd"><ul class="simple">
 333 <li><p><strong>result</strong> -- pointer to initialized <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_result_st</span></code></a> struct</p></li>
 334 <li><p><strong>value</strong> -- byte array to set the value of the current result object to</p></li>
 335 <li><p><strong>length</strong> -- the length of <a class="reference internal" href="#_CPPv426memcached_result_set_valueP19memcached_result_stPKc6size_t" title="memcached_result_set_value::value"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">value</span></code></a> wothout any terminating zero</p></li>
 336 </ul>
 337 </dd>
 338 <dt class="field-even">Returns</dt>
 339 <dd class="field-even"><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> indicating success</p>
 340 </dd>
 341 </dl>
 342 </dd></dl>
 343
 344 <dl class="cpp function">
 345 <dt id="_CPPv426memcached_result_set_flagsP19memcached_result_st8uint32_t">
 346 <span id="_CPPv326memcached_result_set_flagsP19memcached_result_st8uint32_t"></span><span id="_CPPv226memcached_result_set_flagsP19memcached_result_st8uint32_t"></span><span id="memcached_result_set_flags__memcached_result_stP.uint32_t"></span>void <code class="sig-name descname">memcached_result_set_flags</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st">memcached_result_st</a> *<em>result</em>, uint32_t <em>flags</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv426memcached_result_set_flagsP19memcached_result_st8uint32_t" title="Permalink to this definition">¶</a><br /></dt>
 347 <dd><dl class="field-list simple">
 348 <dt class="field-odd">Parameters</dt>
 349 <dd class="field-odd"><ul class="simple">
 350 <li><p><strong>result</strong> -- pointer to initialized <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_result_st</span></code></a> struct</p></li>
 351 <li><p><strong>flags</strong> -- a new value for the flags field</p></li>
 352 </ul>
 353 </dd>
 354 </dl>
 355 </dd></dl>
 356
 357 <dl class="cpp function">
 358 <dt id="_CPPv431memcached_result_set_expirationP19memcached_result_st6time_t">
 359 <span id="_CPPv331memcached_result_set_expirationP19memcached_result_st6time_t"></span><span id="_CPPv231memcached_result_set_expirationP19memcached_result_st6time_t"></span><span id="memcached_result_set_expiration__memcached_result_stP.time_t"></span>void <code class="sig-name descname">memcached_result_set_expiration</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st">memcached_result_st</a> *<em>result</em>, time_t <em>expiration</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv431memcached_result_set_expirationP19memcached_result_st6time_t" title="Permalink to this definition">¶</a><br /></dt>
 360 <dd><dl class="field-list simple">
 361 <dt class="field-odd">Parameters</dt>
 362 <dd class="field-odd"><ul class="simple">
 363 <li><p><strong>result</strong> -- pointer to initialized <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">memcached_result_st</span></code></a> struct</p></li>
 364 <li><p><strong>expiration</strong> -- a new value for the expiration field</p></li>
 365 </ul>
 366 </dd>
 367 </dl>
 368 </dd></dl>
 369
 370 </div>
 371 <div class="section" id="description">
 372 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 373 <p><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">libmemcached</span></code> can optionally return a <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_result_st</span></code></a> which
 374 acts as a result object. The result objects have added benefits over the
 375 character pointer return values, in that they are forward compatible with new
 376 return items that future memcached servers may implement (the best current
 377 example of this is the CAS return item). The structures can also be reused,
 378 which will save on calls to <em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/3/malloc">malloc(3)</a></em>. It is suggested that you use
 379 result objects over char * return functions.</p>
 380 <p>The structure of <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_result_st</span></code></a> has been encapsulated, you should
 381 not write code directly accessing members of the structure.</p>
 382 <p><a class="reference internal" href="#_CPPv423memcached_result_createP12memcached_stP19memcached_result_st" title="memcached_result_create"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_result_create()</span></code></a> will either allocate memory for a
 383 <a class="reference internal" href="#_CPPv419memcached_result_st" title="memcached_result_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_result_st</span></code></a> or will initialize a structure passed to it.</p>
 384 <p><a class="reference internal" href="#_CPPv421memcached_result_freeP19memcached_result_st" title="memcached_result_free"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_result_free()</span></code></a> will deallocate any memory attached to the
 385 structure. If the structure was also allocated, it will deallocate it.</p>
 386 <p><a class="reference internal" href="#_CPPv426memcached_result_key_valueP19memcached_result_st" title="memcached_result_key_value"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_result_key_value()</span></code></a> returns the key value associated with the
 387 current result object.</p>
 388 <p><a class="reference internal" href="#_CPPv427memcached_result_key_lengthPK19memcached_result_st" title="memcached_result_key_length"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_result_key_length()</span></code></a> returns the key length associated with
 389 the current result object.</p>
 390 <p><a class="reference internal" href="#_CPPv422memcached_result_valueP19memcached_result_st" title="memcached_result_value"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_result_value()</span></code></a> returns the result value associated with the
 391 current result object.</p>
 392 <p><a class="reference internal" href="#_CPPv427memcached_result_take_valueP19memcached_result_st" title="memcached_result_take_value"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_result_take_value()</span></code></a> returns and hands over the result value
 393 associated with the current result object. You must call <em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/3/free">free(3)</a></em> to
 394 release this value, unless you have made use of a custom allocator. Use of a
 395 custom allocator requires that you create your own custom free() to release it.</p>
 396 <p><a class="reference internal" href="#_CPPv423memcached_result_lengthPK19memcached_result_st" title="memcached_result_length"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_result_length()</span></code></a> returns the result length associated with
 397 the current result object.</p>
 398 <p><a class="reference internal" href="#_CPPv422memcached_result_flagsPK19memcached_result_st" title="memcached_result_flags"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_result_flags()</span></code></a> returns the flags associated with the
 399 current result object.</p>
 400 <p><a class="reference internal" href="#_CPPv420memcached_result_casPK19memcached_result_st" title="memcached_result_cas"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_result_cas()</span></code></a> returns the cas associated with the
 401 current result object. This value will only be available if the server
 402 tests it.</p>
 403 <p><a class="reference internal" href="#_CPPv426memcached_result_set_valueP19memcached_result_stPKc6size_t" title="memcached_result_set_value"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_result_set_value()</span></code></a> takes a byte array and a size and sets
 404 the result to this value. This function is used for trigger responses.</p>
 405 <p><a class="reference internal" href="#_CPPv426memcached_result_set_flagsP19memcached_result_st8uint32_t" title="memcached_result_set_flags"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_result_set_flags()</span></code></a> takes a result structure and stores a new
 406 value for the flags field.</p>
 407 <p><a class="reference internal" href="#_CPPv431memcached_result_set_expirationP19memcached_result_st6time_t" title="memcached_result_set_expiration"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_result_set_expiration()</span></code></a> takes a result structure and stores
 408 a new value for the expiration field (this is only used by read through
 409 triggers).</p>
 410 </div>
 411 <div class="section" id="return-value">
 412 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 413 <p>Varies, see particular functions. All structures must have
 414 <a class="reference internal" href="#_CPPv421memcached_result_freeP19memcached_result_st" title="memcached_result_free"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_result_free()</span></code></a> called on them for cleanup purposes. Failure
 415 to do this will result in leaked memory.</p>
 416 </div>
 417 <div class="section" id="see-also">
 418 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 419 <ul class="simple">
 420 <li><p><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></p></li>
 421 <li><p><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></p></li>
 422 <li><p><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></p></li>
 423 <li><p><a class="reference internal" href="memcached_memory_allocators.html"><span class="doc">Use custom allocators for embedded usage</span></a></p></li>
 424 </ul>
 425 </div>
 426 </div>
 427
 428
 429            </div>
 430
 431           </div>
 432           <footer>
 433
 434     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 435
 436         <a href="memcached_append.html" class="btn btn-neutral float-right" title="Appending or Prepending Data" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 437
 438
 439         <a href="memcached_flush_buffers.html" class="btn btn-neutral float-left" title="Flush and send buffered commands" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 440
 441     </div>
 442
 443
 444   <hr/>
 445
 446   <div role="contentinfo">
 447     <p>
 448
 449
 450         &copy; <a href="../copyright.html">Copyright</a>
 451
 452     </p>
 453   </div>
 454
 455
 456
 457     Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
 458
 459     <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
 460
 461     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 462
 463 </footer>
 464
 465         </div>
 466       </div>
 467
 468     </section>
 469
 470   </div>
 471
 472
 473   <script type="text/javascript">
 474       jQuery(function () {
 475           SphinxRtdTheme.Navigation.enable(true);
 476       });
 477   </script>
 478
 479
 480
 481
 482
 483
 484 </body>
 485 </html>