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]-->
9 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0">
11 <title>memcached_fetch
— libmemcached
1.0.99 documentation
</title>
20 <script type=
"text/javascript" src=
"../_static/js/modernizr.min.js"></script>
23 <script type=
"text/javascript" id=
"documentation_options" data-url_root=
"../" src=
"../_static/documentation_options.js"></script>
24 <script src=
"../_static/jquery.js"></script>
25 <script src=
"../_static/underscore.js"></script>
26 <script src=
"../_static/doctools.js"></script>
27 <script src=
"../_static/language_data.js"></script>
29 <script type=
"text/javascript" src=
"../_static/js/theme.js"></script>
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=
"Misc" href=
"index_misc.html" />
40 <link rel=
"prev" title=
"Deprecated Functionality" href=
"index_deprecated.html" />
43 <body class=
"wy-body-for-nav">
46 <div class=
"wy-grid-for-nav">
48 <nav data-toggle=
"wy-nav-shift" class=
"wy-nav-side">
49 <div class=
"wy-side-scroll">
50 <div class=
"wy-side-nav-search" >
54 <a href=
"../index.html" class=
"icon icon-home"> libmemcached
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" />
81 <div class=
"wy-menu wy-menu-vertical" data-spy=
"affix" role=
"navigation" aria-label=
"main navigation">
88 <p class=
"caption"><span class=
"caption-text">libmemcached
</span></p>
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"><a class=
"reference internal" href=
"index_data.html">Working with Data
</a></li>
94 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_errors.html">Messages and Errors
</a></li>
95 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_advanced.html">Advanced Topics
</a></li>
96 <li class=
"toctree-l2 current"><a class=
"reference internal" href=
"index_deprecated.html">Deprecated Functionality
</a><ul class=
"current">
97 <li class=
"toctree-l3 current"><a class=
"current reference internal" href=
"#">memcached_fetch
</a></li>
102 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_misc.html">Misc
</a></li>
104 <p class=
"caption"><span class=
"caption-text">libmemcachedutil
</span></p>
106 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil.html">Introduction
</a></li>
107 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcachedutil/index.html">libmemcachedutil API
</a></li>
109 <p class=
"caption"><span class=
"caption-text">libhashkit
</span></p>
111 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit.html">Introduction
</a></li>
112 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libhashkit/index.html">libhashkit API
</a></li>
114 <p class=
"caption"><span class=
"caption-text">Client Applications
</span></p>
116 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../bin/index.html">Client Applications
</a></li>
118 <p class=
"caption"><span class=
"caption-text">Copyright
</span></p>
120 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../copyright.html">Copyright
</a></li>
129 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
132 <nav class=
"wy-nav-top" aria-label=
"top navigation">
134 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
135 <a href=
"../index.html">libmemcached
</a>
140 <div class=
"wy-nav-content">
142 <div class=
"rst-content">
160 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
162 <ul class=
"wy-breadcrumbs">
164 <li><a href=
"../index.html">Docs
</a> »</li>
166 <li><a href=
"index.html">libmemcached API
</a> »</li>
168 <li><a href=
"index_deprecated.html">Deprecated Functionality
</a> »</li>
170 <li>memcached_fetch
</li>
173 <li class=
"wy-breadcrumbs-aside">
184 <div role=
"main" class=
"document" itemscope=
"itemscope" itemtype=
"http://schema.org/Article">
185 <div itemprop=
"articleBody">
187 <div class=
"section" id=
"memcached-fetch">
188 <h1>memcached_fetch
<a class=
"headerlink" href=
"#memcached-fetch" title=
"Permalink to this headline">¶
</a></h1>
189 <div class=
"section" id=
"synopsis">
190 <span id=
"index-0"></span><h2>SYNOPSIS
<a class=
"headerlink" href=
"#synopsis" title=
"Permalink to this headline">¶
</a></h2>
191 <p>#include
<libmemcached/memcached.h
></p>
192 <dl class=
"function">
193 <dt id=
"_CPPv415memcached_fetchP12memcached_stPcP6size_tP6size_tP8uint32_tP18memcached_return_t">
194 <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=
"sig-name 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>
195 <dd><div class=
"deprecated">
196 <p><span class=
"versionmodified deprecated">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>
200 <p>Compile and link with -lmemcached
</p>
202 <div class=
"section" id=
"description">
203 <h2>DESCRIPTION
<a class=
"headerlink" href=
"#description" title=
"Permalink to this headline">¶
</a></h2>
204 <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.
<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.
205 You must pass in a key and its length to fetch the object. You must supply
206 three pointer variables which will give you the state of the returned
207 object. 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, 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
208 object, and 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. The
209 object will be returned upon success and NULL will be returned on failure.
<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. 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 null.
</p>
210 <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>
211 <p>All of the above functions are not tested when the
212 <code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">MEMCACHED_BEHAVIOR_USE_UDP
</span></code> has been set. Executing any of these
213 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> being returned, or for those functions which do not return 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>, the error function parameter will 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>
215 <div class=
"section" id=
"return-value">
216 <h2>RETURN VALUE
<a class=
"headerlink" href=
"#return-value" title=
"Permalink to this headline">¶
</a></h2>
217 <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
218 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.
219 <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>
220 <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
221 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
222 key allowed for the original memcached ascii server.
</p>
224 <div class=
"section" id=
"see-also">
225 <h2>SEE ALSO
<a class=
"headerlink" href=
"#see-also" title=
"Permalink to this headline">¶
</a></h2>
235 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
237 <a href=
"index_misc.html" class=
"btn btn-neutral float-right" title=
"Misc" accesskey=
"n" rel=
"next">Next
<span class=
"fa fa-arrow-circle-right"></span></a>
240 <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>
247 <div role=
"contentinfo">
249 © <a href=
"../copyright.html">Copyright
</a>
253 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 <script type=
"text/javascript">
268 SphinxRtdTheme.Navigation.enable(true);