Deploy to GitHub pages
[awesomized/libmemcached] / 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.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="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.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"><a class="reference internal" href="memcached_exist.html">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 current"><a class="current reference internal" href="#">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>Working with result sets</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_result_st.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="working-with-result-sets">
186 <h1>Working with result sets<a class="headerlink" href="#working-with-result-sets" 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 -lmemcachedutil -lmemcached</dd>
192 </dl>
193 <dl class="type">
194 <dt id="_CPPv419memcached_result_st">
195 <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>
196 <dd></dd></dl>
197
198 <dl class="function">
199 <dt id="_CPPv423memcached_result_createP12memcached_stP19memcached_result_st">
200 <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>
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 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>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
208 nullptr to allocate a new instance</li>
209 </ul>
210 </td>
211 </tr>
212 <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>
213 </td>
214 </tr>
215 </tbody>
216 </table>
217 </dd></dl>
218
219 <dl class="function">
220 <dt id="_CPPv421memcached_result_freeP19memcached_result_st">
221 <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>
222 <dd><table class="docutils field-list" frame="void" rules="none">
223 <col class="field-name" />
224 <col class="field-body" />
225 <tbody valign="top">
226 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>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>
227 </tr>
228 </tbody>
229 </table>
230 </dd></dl>
231
232 <dl class="function">
233 <dt id="_CPPv426memcached_result_key_valueP19memcached_result_st">
234 <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>
235 <dd><table class="docutils field-list" frame="void" rules="none">
236 <col class="field-name" />
237 <col class="field-body" />
238 <tbody valign="top">
239 <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>
240 </tr>
241 <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>
242 </tr>
243 </tbody>
244 </table>
245 </dd></dl>
246
247 <dl class="function">
248 <dt id="_CPPv427memcached_result_key_lengthPK19memcached_result_st">
249 <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>
250 <dd><table class="docutils field-list" frame="void" rules="none">
251 <col class="field-name" />
252 <col class="field-body" />
253 <tbody valign="top">
254 <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>
255 </tr>
256 <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>
257 </tr>
258 </tbody>
259 </table>
260 </dd></dl>
261
262 <dl class="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="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><table class="docutils field-list" frame="void" rules="none">
266 <col class="field-name" />
267 <col class="field-body" />
268 <tbody valign="top">
269 <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>
270 </tr>
271 <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>
272 </tr>
273 </tbody>
274 </table>
275 </dd></dl>
276
277 <dl class="function">
278 <dt id="_CPPv427memcached_result_take_valueP19memcached_result_st">
279 <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>
280 <dd><table class="docutils field-list" frame="void" rules="none">
281 <col class="field-name" />
282 <col class="field-body" />
283 <tbody valign="top">
284 <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>
285 </tr>
286 <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>
287 </tr>
288 </tbody>
289 </table>
290 </dd></dl>
291
292 <dl class="function">
293 <dt id="_CPPv423memcached_result_lengthPK19memcached_result_st">
294 <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>
295 <dd><table class="docutils field-list" frame="void" rules="none">
296 <col class="field-name" />
297 <col class="field-body" />
298 <tbody valign="top">
299 <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>
300 </tr>
301 <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>
302 </tr>
303 </tbody>
304 </table>
305 </dd></dl>
306
307 <dl class="function">
308 <dt id="_CPPv422memcached_result_flagsPK19memcached_result_st">
309 <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>
310 <dd><table class="docutils field-list" frame="void" rules="none">
311 <col class="field-name" />
312 <col class="field-body" />
313 <tbody valign="top">
314 <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>
315 </tr>
316 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the flags associated with the current result object</td>
317 </tr>
318 </tbody>
319 </table>
320 </dd></dl>
321
322 <dl class="function">
323 <dt id="_CPPv420memcached_result_casPK19memcached_result_st">
324 <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>
325 <dd><table class="docutils field-list" frame="void" rules="none">
326 <col class="field-name" />
327 <col class="field-body" />
328 <tbody valign="top">
329 <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>
330 </tr>
331 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the cas associated with the current result object</td>
332 </tr>
333 </tbody>
334 </table>
335 </dd></dl>
336
337 <dl class="function">
338 <dt id="_CPPv426memcached_result_set_valueP19memcached_result_stPKc6size_t">
339 <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>
340 <dd><table class="docutils field-list" frame="void" rules="none">
341 <col class="field-name" />
342 <col class="field-body" />
343 <tbody valign="top">
344 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
345 <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>
346 <li><strong>value</strong> -- byte array to set the value of the current result object to</li>
347 <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>
348 </ul>
349 </td>
350 </tr>
351 <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>
352 </td>
353 </tr>
354 </tbody>
355 </table>
356 </dd></dl>
357
358 <dl class="function">
359 <dt id="_CPPv426memcached_result_set_flagsP19memcached_result_st8uint32_t">
360 <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>
361 <dd><table class="docutils field-list" frame="void" rules="none">
362 <col class="field-name" />
363 <col class="field-body" />
364 <tbody valign="top">
365 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
366 <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>
367 <li><strong>flags</strong> -- a new value for the flags field</li>
368 </ul>
369 </td>
370 </tr>
371 </tbody>
372 </table>
373 </dd></dl>
374
375 <dl class="function">
376 <dt id="_CPPv431memcached_result_set_expirationP19memcached_result_st6time_t">
377 <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>
378 <dd><table class="docutils field-list" frame="void" rules="none">
379 <col class="field-name" />
380 <col class="field-body" />
381 <tbody valign="top">
382 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
383 <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>
384 <li><strong>expiration</strong> -- a new value for the expiration field</li>
385 </ul>
386 </td>
387 </tr>
388 </tbody>
389 </table>
390 </dd></dl>
391
392 </div>
393 <div class="section" id="description">
394 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
395 <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
396 acts as a result object. The result objects have added benefits over the
397 character pointer return values, in that they are forward compatible with new
398 return items that future memcached servers may implement (the best current
399 example of this is the CAS return item). The structures can also be reused,
400 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
401 result objects over char * return functions.</p>
402 <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
403 not write code directly accessing members of the structure.</p>
404 <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
405 <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>
406 <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
407 structure. If the structure was also allocated, it will deallocate it.</p>
408 <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
409 current result object.</p>
410 <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
411 the current result object.</p>
412 <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
413 current result object.</p>
414 <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
415 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
416 release this value, unless you have made use of a custom allocator. Use of a
417 custom allocator requires that you create your own custom free() to release it.</p>
418 <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
419 the current result object.</p>
420 <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
421 current result object.</p>
422 <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
423 current result object. This value will only be available if the server
424 tests it.</p>
425 <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
426 the result to this value. This function is used for trigger responses.</p>
427 <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
428 value for the flags field.</p>
429 <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
430 a new value for the expiration field (this is only used by read through
431 triggers).</p>
432 </div>
433 <div class="section" id="return-value">
434 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline"></a></h2>
435 <p>Varies, see particular functions. All structures must have
436 <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
437 to do this will result in leaked memory.</p>
438 </div>
439 <div class="section" id="see-also">
440 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
441 <ul class="simple">
442 <li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></li>
443 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
444 <li><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></li>
445 <li><a class="reference internal" href="memcached_memory_allocators.html"><span class="doc">Use custom allocators for embedded usage</span></a></li>
446 </ul>
447 </div>
448 </div>
449
450
451 </div>
452
453 </div>
454 <footer>
455
456 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
457
458 <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>
459
460
461 <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>
462
463 </div>
464
465
466 <hr/>
467
468 <div role="contentinfo">
469 <p>
470 &copy; <a href="../copyright.html">Copyright</a>
471
472 </p>
473 </div>
474 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>.
475
476 </footer>
477
478 </div>
479 </div>
480
481 </section>
482
483 </div>
484
485
486
487 <script type="text/javascript">
488 jQuery(function () {
489 SphinxRtdTheme.Navigation.enable(true);
490 });
491 </script>
492
493
494
495
496
497
498 </body>
499 </html>