git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached/memcached_result_st.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>Working with result sets &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 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="Appending or Prepending Data" href="memcached_append.html" />
  40     <link rel="prev" title="Flush and send buffered commands" href="memcached_flush_buffers.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><ul class="current">
  94 <li class="toctree-l3"><a class="reference internal" href="memcached_auto.html">Incrementing and Decrementing Values</a></li>
  95 <li class="toctree-l3"><a class="reference internal" href="memcached_exist.html">Determine if a keys exists</a></li>
  96 <li class="toctree-l3"><a class="reference internal" href="memcached_touch.html">Update expiration on a key</a></li>
  97 <li class="toctree-l3"><a class="reference internal" href="memcached_flush_buffers.html">Flush and send buffered commands</a></li>
  98 <li class="toctree-l3 current"><a class="current reference internal" href="#">Working with result sets</a></li>
  99 <li class="toctree-l3"><a class="reference internal" href="memcached_append.html">Appending or Prepending Data</a></li>
 100 <li class="toctree-l3"><a class="reference internal" href="memcached_cas.html">Working with data on the server in an atomic fashion</a></li>
 101 </ul>
 102 </li>
 103 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
 104 <li class="toctree-l2"><a class="reference internal" href="index_advanced.html">Advanced Topics</a></li>
 105 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
 106 </ul>
 107 </li>
 108 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a></li>
 109 </ul>
 110 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 111 <ul>
 112 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
 113 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></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></li>
 119 </ul>
 120 <p class="caption"><span class="caption-text">Client Applications</span></p>
 121 <ul>
 122 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 123 </ul>
 124 <p class="caption"><span class="caption-text">Copyright</span></p>
 125 <ul>
 126 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 127 </ul>
 128
 129
 130
 131         </div>
 132       </div>
 133     </nav>
 134
 135     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 136
 137
 138       <nav class="wy-nav-top" aria-label="top navigation">
 139
 140           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 141           <a href="../index.html">libmemcached</a>
 142
 143       </nav>
 144
 145
 146       <div class="wy-nav-content">
 147
 148         <div class="rst-content">
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166 <div role="navigation" aria-label="breadcrumbs navigation">
 167
 168   <ul class="wy-breadcrumbs">
 169
 170       <li><a href="../index.html">Docs</a> &raquo;</li>
 171
 172           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 173
 174           <li><a href="index_data.html">Working with Data</a> &raquo;</li>
 175
 176       <li>Working with result sets</li>
 177
 178
 179       <li class="wy-breadcrumbs-aside">
 180
 181
 182
 183       </li>
 184
 185   </ul>
 186
 187
 188   <hr/>
 189 </div>
 190           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 191            <div itemprop="articleBody">
 192
 193   <div class="section" id="working-with-result-sets">
 194 <h1>Working with result sets<a class="headerlink" href="#working-with-result-sets" title="Permalink to this headline">¶</a></h1>
 195 <div class="section" id="synopsis">
 196 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 197 <dl class="docutils">
 198 <dt>#include &lt;libmemcached/memcached.h&gt;</dt>
 199 <dd>Compile and link with -lmemcachedutil -lmemcached</dd>
 200 </dl>
 201 <dl class="type">
 202 <dt id="_CPPv419memcached_result_st">
 203 <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="descname">memcached_result_st</code><a class="headerlink" href="#_CPPv419memcached_result_st" title="Permalink to this definition">¶</a><br /></dt>
 204 <dd></dd></dl>
 205
 206 <dl class="function">
 207 <dt id="_CPPv423memcached_result_createP12memcached_stP19memcached_result_st">
 208 <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="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>
 209 <dd><table class="docutils field-list" frame="void" rules="none">
 210 <col class="field-name" />
 211 <col class="field-body" />
 212 <tbody valign="top">
 213 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 214 <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>
 215 <li><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
 216 nullptr to allocate a new instance</li>
 217 </ul>
 218 </td>
 219 </tr>
 220 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">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>
 221 </td>
 222 </tr>
 223 </tbody>
 224 </table>
 225 </dd></dl>
 226
 227 <dl class="function">
 228 <dt id="_CPPv421memcached_result_freeP19memcached_result_st">
 229 <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="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>
 230 <dd><table class="docutils field-list" frame="void" rules="none">
 231 <col class="field-name" />
 232 <col class="field-body" />
 233 <tbody valign="top">
 234 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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</td>
 235 </tr>
 236 </tbody>
 237 </table>
 238 </dd></dl>
 239
 240 <dl class="function">
 241 <dt id="_CPPv426memcached_result_key_valueP19memcached_result_st">
 242 <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="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>
 243 <dd><table class="docutils field-list" frame="void" rules="none">
 244 <col class="field-name" />
 245 <col class="field-body" />
 246 <tbody valign="top">
 247 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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</td>
 248 </tr>
 249 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the key value associated with the current result object</td>
 250 </tr>
 251 </tbody>
 252 </table>
 253 </dd></dl>
 254
 255 <dl class="function">
 256 <dt id="_CPPv427memcached_result_key_lengthPK19memcached_result_st">
 257 <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="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>
 258 <dd><table class="docutils field-list" frame="void" rules="none">
 259 <col class="field-name" />
 260 <col class="field-body" />
 261 <tbody valign="top">
 262 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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</td>
 263 </tr>
 264 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the key length associated with the current result object</td>
 265 </tr>
 266 </tbody>
 267 </table>
 268 </dd></dl>
 269
 270 <dl class="function">
 271 <dt id="_CPPv422memcached_result_valueP19memcached_result_st">
 272 <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="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>
 273 <dd><table class="docutils field-list" frame="void" rules="none">
 274 <col class="field-name" />
 275 <col class="field-body" />
 276 <tbody valign="top">
 277 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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</td>
 278 </tr>
 279 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the result value associated with the current result object</td>
 280 </tr>
 281 </tbody>
 282 </table>
 283 </dd></dl>
 284
 285 <dl class="function">
 286 <dt id="_CPPv427memcached_result_take_valueP19memcached_result_st">
 287 <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="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>
 288 <dd><table class="docutils field-list" frame="void" rules="none">
 289 <col class="field-name" />
 290 <col class="field-body" />
 291 <tbody valign="top">
 292 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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</td>
 293 </tr>
 294 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the result value associated with the current result object</td>
 295 </tr>
 296 </tbody>
 297 </table>
 298 </dd></dl>
 299
 300 <dl class="function">
 301 <dt id="_CPPv423memcached_result_lengthPK19memcached_result_st">
 302 <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="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>
 303 <dd><table class="docutils field-list" frame="void" rules="none">
 304 <col class="field-name" />
 305 <col class="field-body" />
 306 <tbody valign="top">
 307 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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</td>
 308 </tr>
 309 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the result length associated with the current result object</td>
 310 </tr>
 311 </tbody>
 312 </table>
 313 </dd></dl>
 314
 315 <dl class="function">
 316 <dt id="_CPPv422memcached_result_flagsPK19memcached_result_st">
 317 <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="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>
 318 <dd><table class="docutils field-list" frame="void" rules="none">
 319 <col class="field-name" />
 320 <col class="field-body" />
 321 <tbody valign="top">
 322 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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</td>
 323 </tr>
 324 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the flags associated with the current result object</td>
 325 </tr>
 326 </tbody>
 327 </table>
 328 </dd></dl>
 329
 330 <dl class="function">
 331 <dt id="_CPPv420memcached_result_casPK19memcached_result_st">
 332 <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="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>
 333 <dd><table class="docutils field-list" frame="void" rules="none">
 334 <col class="field-name" />
 335 <col class="field-body" />
 336 <tbody valign="top">
 337 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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</td>
 338 </tr>
 339 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the cas associated with the current result object</td>
 340 </tr>
 341 </tbody>
 342 </table>
 343 </dd></dl>
 344
 345 <dl class="function">
 346 <dt id="_CPPv426memcached_result_set_valueP19memcached_result_stPKc6size_t">
 347 <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="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>
 348 <dd><table class="docutils field-list" frame="void" rules="none">
 349 <col class="field-name" />
 350 <col class="field-body" />
 351 <tbody valign="top">
 352 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 353 <li><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</li>
 354 <li><strong>value</strong> -- byte array to set the value of the current result object to</li>
 355 <li><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</li>
 356 </ul>
 357 </td>
 358 </tr>
 359 <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>
 360 </td>
 361 </tr>
 362 </tbody>
 363 </table>
 364 </dd></dl>
 365
 366 <dl class="function">
 367 <dt id="_CPPv426memcached_result_set_flagsP19memcached_result_st8uint32_t">
 368 <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="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>
 369 <dd><table class="docutils field-list" frame="void" rules="none">
 370 <col class="field-name" />
 371 <col class="field-body" />
 372 <tbody valign="top">
 373 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 374 <li><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</li>
 375 <li><strong>flags</strong> -- a new value for the flags field</li>
 376 </ul>
 377 </td>
 378 </tr>
 379 </tbody>
 380 </table>
 381 </dd></dl>
 382
 383 <dl class="function">
 384 <dt id="_CPPv431memcached_result_set_expirationP19memcached_result_st6time_t">
 385 <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="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>
 386 <dd><table class="docutils field-list" frame="void" rules="none">
 387 <col class="field-name" />
 388 <col class="field-body" />
 389 <tbody valign="top">
 390 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 391 <li><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</li>
 392 <li><strong>expiration</strong> -- a new value for the expiration field</li>
 393 </ul>
 394 </td>
 395 </tr>
 396 </tbody>
 397 </table>
 398 </dd></dl>
 399
 400 </div>
 401 <div class="section" id="description">
 402 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 403 <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
 404 acts as a result object. The result objects have added benefits over the
 405 character pointer return values, in that they are forward compatible with new
 406 return items that future memcached servers may implement (the best current
 407 example of this is the CAS return item). The structures can also be reused,
 408 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
 409 result objects over char * return functions.</p>
 410 <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
 411 not write code directly accessing members of the structure.</p>
 412 <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
 413 <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>
 414 <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
 415 structure. If the structure was also allocated, it will deallocate it.</p>
 416 <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
 417 current result object.</p>
 418 <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
 419 the current result object.</p>
 420 <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
 421 current result object.</p>
 422 <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
 423 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
 424 release this value, unless you have made use of a custom allocator. Use of a
 425 custom allocator requires that you create your own custom free() to release it.</p>
 426 <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
 427 the current result object.</p>
 428 <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
 429 current result object.</p>
 430 <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
 431 current result object. This value will only be available if the server
 432 tests it.</p>
 433 <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
 434 the result to this value. This function is used for trigger responses.</p>
 435 <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
 436 value for the flags field.</p>
 437 <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
 438 a new value for the expiration field (this is only used by read through
 439 triggers).</p>
 440 </div>
 441 <div class="section" id="return-value">
 442 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 443 <p>Varies, see particular functions. All structures must have
 444 <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
 445 to do this will result in leaked memory.</p>
 446 </div>
 447 <div class="section" id="see-also">
 448 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 449 <ul class="simple">
 450 <li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></li>
 451 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
 452 <li><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></li>
 453 <li><a class="reference internal" href="memcached_memory_allocators.html"><span class="doc">Use custom allocators for embedded usage</span></a></li>
 454 </ul>
 455 </div>
 456 </div>
 457
 458
 459            </div>
 460
 461           </div>
 462           <footer>
 463
 464     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 465
 466         <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>
 467
 468
 469         <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>
 470
 471     </div>
 472
 473
 474   <hr/>
 475
 476   <div role="contentinfo">
 477     <p>
 478         &copy; <a href="../copyright.html">Copyright</a>
 479
 480     </p>
 481   </div>
 482   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>.
 483
 484 </footer>
 485
 486         </div>
 487       </div>
 488
 489     </section>
 490
 491   </div>
 492
 493
 494
 495   <script type="text/javascript">
 496       jQuery(function () {
 497           SphinxRtdTheme.Navigation.enable(true);
 498       });
 499   </script>
 500
 501
 502
 503
 504
 505
 506 </body>
 507 </html>