Deploy to GitHub pages
[awesomized/libmemcached] / libmemcached / memcached_fetch.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>memcached_fetch &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="libmemcachedutil - C/C++ utilities extending libmemcached" href="../libmemcachedutil/index.html" />
40 <link rel="prev" title="Deprecated Functionality" href="index_deprecated.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"><a class="reference internal" href="index_data.html">Working with Data</a></li>
93 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
94 <li class="toctree-l2"><a class="reference internal" href="index_advanced.html">Advanced Topics</a></li>
95 <li class="toctree-l2 current"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a><ul class="current">
96 <li class="toctree-l3 current"><a class="current reference internal" href="#">memcached_fetch</a></li>
97 </ul>
98 </li>
99 </ul>
100 </li>
101 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
102 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
103 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
104 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Miscellaneous</a></li>
105 </ul>
106 <ul>
107 <li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
108 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
109 </ul>
110
111
112
113 </div>
114 </div>
115 </nav>
116
117 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
118
119
120 <nav class="wy-nav-top" aria-label="top navigation">
121
122 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
123 <a href="../index.html">libmemcached</a>
124
125 </nav>
126
127
128 <div class="wy-nav-content">
129
130 <div class="rst-content">
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148 <div role="navigation" aria-label="breadcrumbs navigation">
149
150 <ul class="wy-breadcrumbs">
151
152 <li><a href="../index.html">Docs</a> &raquo;</li>
153
154 <li><a href="index.html">libmemcached API</a> &raquo;</li>
155
156 <li><a href="index_deprecated.html">Deprecated Functionality</a> &raquo;</li>
157
158 <li>memcached_fetch</li>
159
160
161 <li class="wy-breadcrumbs-aside">
162
163
164
165 <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libmemcached/memcached_fetch.rst" class="fa fa-github"> Edit on GitHub</a>
166
167
168
169 </li>
170
171 </ul>
172
173
174 <hr/>
175 </div>
176 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
177 <div itemprop="articleBody">
178
179 <div class="section" id="memcached-fetch">
180 <h1>memcached_fetch<a class="headerlink" href="#memcached-fetch" title="Permalink to this headline"></a></h1>
181 <div class="section" id="synopsis">
182 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
183 <dl class="docutils">
184 <dt>#include &lt;libmemcached/memcached.h&gt;</dt>
185 <dd>Compile and link with -lmemcached</dd>
186 </dl>
187 <dl class="function">
188 <dt id="_CPPv415memcached_fetchP12memcached_stPcP6size_tP6size_tP8uint32_tP18memcached_return_t">
189 <span id="_CPPv315memcached_fetchP12memcached_stPcP6size_tP6size_tP8uint32_tP18memcached_return_t"></span><span id="_CPPv215memcached_fetchP12memcached_stPcP6size_tP6size_tP8uint32_tP18memcached_return_t"></span><span id="memcached_fetch__memcached_stP.cP.sP.sP.uint32_tP.memcached_return_tP"></span>char *<code class="descname">memcached_fetch</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, char *<em>key</em>, size_t *<em>key_length</em>, size_t *<em>value_length</em>, uint32_t *<em>flags</em>, <a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> *<em>error</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415memcached_fetchP12memcached_stPcP6size_tP6size_tP8uint32_tP18memcached_return_t" title="Permalink to this definition"></a><br /></dt>
190 <dd><div class="deprecated">
191 <p><span class="versionmodified">Deprecated since version 0.50: </span>Use <a class="reference internal" href="memcached_get.html#_CPPv422memcached_fetch_resultP12memcached_stP19memcached_result_stP18memcached_return_t" title="memcached_fetch_result"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_fetch_result()</span></code></a> instead.</p>
192 </div>
193 </dd></dl>
194
195 </div>
196 <div class="section" id="description">
197 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
198 <p><a class="reference internal" href="#_CPPv415memcached_fetchP12memcached_stPcP6size_tP6size_tP8uint32_tP18memcached_return_t" title="memcached_fetch"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_fetch()</span></code></a> is used to fetch an individual value from the server.
199 <a class="reference internal" href="memcached_get.html#_CPPv414memcached_mgetP12memcached_stPPCKcPK6size_t6size_t" title="memcached_mget"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_mget()</span></code></a> must always be called before using this method.
200 You must pass in a key and its length to fetch the object.</p>
201 <p>You must supply three pointer variables which will give you the state of the returned
202 object:</p>
203 <blockquote>
204 <div><ul class="simple">
205 <li>A <code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">uint32_t</span></code> pointer to contain whatever flags you stored with the value,</li>
206 <li>a <code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">size_t</span></code> pointer which will be filled with size of of the object, and</li>
207 <li>a <a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_return_t</span></code></a> pointer to hold any error.</li>
208 </ul>
209 </div></blockquote>
210 <p>The object will be returned upon success and NULL will be returned on failure.</p>
211 <p><a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t13MEMCACHED_ENDE" title="MEMCACHED_END"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_END</span></code></a> is returned by the error value when all objects that have been found are returned.
212 The final value upon <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t13MEMCACHED_ENDE" title="MEMCACHED_END"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_END</span></code></a> is a NULL pointer.</p>
213 <p>Values returned by <a class="reference internal" href="#_CPPv415memcached_fetchP12memcached_stPcP6size_tP6size_tP8uint32_tP18memcached_return_t" title="memcached_fetch"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_fetch()</span></code></a> must be freed by the caller.</p>
214 <p>All of the above functions are not tested when the
215 <a class="reference internal" href="memcached_behavior.html#_CPPv4N20memcached_behavior_t26MEMCACHED_BEHAVIOR_USE_UDPE" title="MEMCACHED_BEHAVIOR_USE_UDP"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_USE_UDP</span></code></a> has been set. Executing any of these
216 functions with this behavior on will result in <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t23MEMCACHED_NOT_SUPPORTEDE" title="MEMCACHED_NOT_SUPPORTED"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_NOT_SUPPORTED</span></code></a>
217 being returned, or for those functions which do not return a
218 <a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_return_t</span></code></a>, the error function parameter will
219 be set to <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t23MEMCACHED_NOT_SUPPORTEDE" title="MEMCACHED_NOT_SUPPORTED"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_NOT_SUPPORTED</span></code></a>.</p>
220 </div>
221 <div class="section" id="return-value">
222 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline"></a></h2>
223 <p><a class="reference internal" href="#_CPPv415memcached_fetchP12memcached_stPcP6size_tP6size_tP8uint32_tP18memcached_return_t" title="memcached_fetch"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_fetch()</span></code></a> sets error to
224 to <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t13MEMCACHED_ENDE" title="MEMCACHED_END"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_END</span></code></a> upon successful conclusion.</p>
225 <p><a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t18MEMCACHED_NOTFOUNDE" title="MEMCACHED_NOTFOUND"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_NOTFOUND</span></code></a> will be return if no keys at all were found.</p>
226 <p><a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t21MEMCACHED_KEY_TOO_BIGE" title="MEMCACHED_KEY_TOO_BIG"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_KEY_TOO_BIG</span></code></a> is set to error whenever <a class="reference internal" href="#_CPPv415memcached_fetchP12memcached_stPcP6size_tP6size_tP8uint32_tP18memcached_return_t" title="memcached_fetch"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_fetch()</span></code></a> was used
227 and the key was set larger then <code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_MAX_KEY</span></code>, which was the largest
228 key allowed for the original memcached ascii server.</p>
229 </div>
230 <div class="section" id="see-also">
231 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
232 <ul class="simple">
233 <li><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em></li>
234 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
235 <li><a class="reference internal" href="memcached_strerror.html"><span class="doc">Converting Error Codes to Messages</span></a></li>
236 <li><a class="reference internal" href="memcached_get.html"><span class="doc">Retrieving data from the server</span></a></li>
237 </ul>
238 </div>
239 </div>
240
241
242 </div>
243
244 </div>
245 <footer>
246
247 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
248
249 <a href="../libmemcachedutil/index.html" class="btn btn-neutral float-right" title="libmemcachedutil - C/C++ utilities extending libmemcached" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
250
251
252 <a href="index_deprecated.html" class="btn btn-neutral float-left" title="Deprecated Functionality" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
253
254 </div>
255
256
257 <hr/>
258
259 <div role="contentinfo">
260 <p>
261 &copy; <a href="../copyright.html">Copyright</a>
262
263 </p>
264 </div>
265 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>.
266
267 </footer>
268
269 </div>
270 </div>
271
272 </section>
273
274 </div>
275
276
277
278 <script type="text/javascript">
279 jQuery(function () {
280 SphinxRtdTheme.Navigation.enable(true);
281 });
282 </script>
283
284
285
286
287
288
289 </body>
290 </html>