4 <html class=
"writer-html5" lang=
"en" >
8 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0">
10 <title>Deleting data from a server
— libmemcached
1.0.99 documentation
</title>
14 <link rel=
"stylesheet" href=
"../_static/css/theme.css" type=
"text/css" />
15 <link rel=
"stylesheet" href=
"../_static/pygments.css" type=
"text/css" />
24 <script src="../_static/js/html5shiv.min.js"></script>
28 <script type=
"text/javascript" id=
"documentation_options" data-url_root=
"../" src=
"../_static/documentation_options.js"></script>
29 <script src=
"../_static/jquery.js"></script>
30 <script src=
"../_static/underscore.js"></script>
31 <script src=
"../_static/doctools.js"></script>
32 <script src=
"../_static/language_data.js"></script>
34 <script type=
"text/javascript" src=
"../_static/js/theme.js"></script>
37 <link rel=
"index" title=
"Index" href=
"../genindex.html" />
38 <link rel=
"search" title=
"Search" href=
"../search.html" />
39 <link rel=
"copyright" title=
"Copyright" href=
"../copyright.html" />
40 <link rel=
"next" title=
"Disconnecting a client from a server" href=
"memcached_quit.html" />
41 <link rel=
"prev" title=
"Storing data on the server" href=
"memcached_set.html" />
44 <body class=
"wy-body-for-nav">
47 <div class=
"wy-grid-for-nav">
49 <nav data-toggle=
"wy-nav-shift" class=
"wy-nav-side">
50 <div class=
"wy-side-scroll">
51 <div class=
"wy-side-nav-search" >
55 <a href=
"../index.html" class=
"icon icon-home" alt=
"Documentation Home"> libmemcached
72 <form id=
"rtd-search-form" class=
"wy-form" action=
"../search.html" method=
"get">
73 <input type=
"text" name=
"q" placeholder=
"Search docs" />
74 <input type=
"hidden" name=
"check_keywords" value=
"yes" />
75 <input type=
"hidden" name=
"area" value=
"default" />
83 <div class=
"wy-menu wy-menu-vertical" data-spy=
"affix" role=
"navigation" aria-label=
"main navigation">
90 <p class=
"caption"><span class=
"caption-text">libmemcached
</span></p>
92 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../libmemcached.html">Introduction
</a></li>
93 <li class=
"toctree-l1 current"><a class=
"reference internal" href=
"index.html">libmemcached API
</a><ul class=
"current">
94 <li class=
"toctree-l2 current"><a class=
"reference internal" href=
"index_basics.html">Basics
</a><ul class=
"current">
95 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_create.html">Creating and destroying a memcached_st
</a></li>
96 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_get.html">Retrieving data from the server
</a></li>
97 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_set.html">Storing data on the server
</a></li>
98 <li class=
"toctree-l3 current"><a class=
"current reference internal" href=
"#">Deleting data from a server
</a></li>
99 <li class=
"toctree-l3"><a class=
"reference internal" href=
"memcached_quit.html">Disconnecting a client from a server
</a></li>
102 <li class=
"toctree-l2"><a class=
"reference internal" href=
"index_data.html">Working with Data
</a></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>
108 <li class=
"toctree-l1"><a class=
"reference internal" href=
"index_misc.html">Misc
</a></li>
110 <p class=
"caption"><span class=
"caption-text">libmemcachedutil
</span></p>
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>
115 <p class=
"caption"><span class=
"caption-text">libhashkit
</span></p>
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>
120 <p class=
"caption"><span class=
"caption-text">Client Applications
</span></p>
122 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../bin/index.html">Client Applications
</a></li>
124 <p class=
"caption"><span class=
"caption-text">Copyright
</span></p>
126 <li class=
"toctree-l1"><a class=
"reference internal" href=
"../copyright.html">Copyright
</a></li>
136 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
139 <nav class=
"wy-nav-top" aria-label=
"top navigation">
141 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
142 <a href=
"../index.html">libmemcached
</a>
147 <div class=
"wy-nav-content">
149 <div class=
"rst-content">
167 <div role=
"navigation" aria-label=
"breadcrumbs navigation">
169 <ul class=
"wy-breadcrumbs">
171 <li><a href=
"../index.html" class=
"icon icon-home"></a> »</li>
173 <li><a href=
"index.html">libmemcached API
</a> »</li>
175 <li><a href=
"index_basics.html">Basics
</a> »</li>
177 <li>Deleting data from a server
</li>
180 <li class=
"wy-breadcrumbs-aside">
191 <div role=
"main" class=
"document" itemscope=
"itemscope" itemtype=
"http://schema.org/Article">
192 <div itemprop=
"articleBody">
194 <div class=
"section" id=
"deleting-data-from-a-server">
195 <h1>Deleting data from a server
<a class=
"headerlink" href=
"#deleting-data-from-a-server" title=
"Permalink to this headline">¶
</a></h1>
196 <div class=
"section" id=
"synopsis">
197 <h2>SYNOPSIS
<a class=
"headerlink" href=
"#synopsis" title=
"Permalink to this headline">¶
</a></h2>
199 <dt>#include
<libmemcached/memcached.h
></dt><dd><p>Compile and link with -lmemcached
</p>
202 <dl class=
"cpp function">
203 <dt id=
"_CPPv416memcached_deleteP12memcached_stPKc6size_t6time_t">
204 <span id=
"_CPPv316memcached_deleteP12memcached_stPKc6size_t6time_t"></span><span id=
"_CPPv216memcached_deleteP12memcached_stPKc6size_t6time_t"></span><span id=
"memcached_delete__memcached_stP.cCP.s.time_t"></span><a class=
"reference internal" href=
"memcached_return_t.html#_CPPv418memcached_return_t" title=
"memcached_return_t">memcached_return_t
</a> <code class=
"sig-name descname">memcached_delete
</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>,
<em class=
"property">const
</em> char *
<em>key
</em>, size_t
<em>key_length
</em>, time_t
<em>expiration
</em><span class=
"sig-paren">)
</span><a class=
"headerlink" href=
"#_CPPv416memcached_deleteP12memcached_stPKc6size_t6time_t" title=
"Permalink to this definition">¶
</a><br /></dt>
207 <dl class=
"cpp function">
208 <dt id=
"_CPPv423memcached_delete_by_keyP12memcached_stPKc6size_tPKc6size_t6time_t">
209 <span id=
"_CPPv323memcached_delete_by_keyP12memcached_stPKc6size_tPKc6size_t6time_t"></span><span id=
"_CPPv223memcached_delete_by_keyP12memcached_stPKc6size_tPKc6size_t6time_t"></span><span id=
"memcached_delete_by_key__memcached_stP.cCP.s.cCP.s.time_t"></span><a class=
"reference internal" href=
"memcached_return_t.html#_CPPv418memcached_return_t" title=
"memcached_return_t">memcached_return_t
</a> <code class=
"sig-name descname">memcached_delete_by_key
</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>,
<em class=
"property">const
</em> char *
<em>group_key
</em>, size_t
<em>group_key_length
</em>,
<em class=
"property">const
</em> char *
<em>key
</em>, size_t
<em>key_length
</em>, time_t
<em>expiration
</em><span class=
"sig-paren">)
</span><a class=
"headerlink" href=
"#_CPPv423memcached_delete_by_keyP12memcached_stPKc6size_tPKc6size_t6time_t" title=
"Permalink to this definition">¶
</a><br /></dt>
210 <dd><dl class=
"field-list simple">
211 <dt class=
"field-odd">Parameters
</dt>
212 <dd class=
"field-odd"><ul class=
"simple">
213 <li><p><strong>ptr
</strong> -- pointer to initialized
<a class=
"reference internal" href=
"memcached_create.html#_CPPv412memcached_st" title=
"memcached_st"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_st
</span></code></a> struct
</p></li>
214 <li><p><strong>group_key
</strong> -- key namespace
</p></li>
215 <li><p><strong>group_key_length
</strong> -- length of the
<a class=
"reference internal" href=
"#_CPPv423memcached_delete_by_keyP12memcached_stPKc6size_tPKc6size_t6time_t" title=
"memcached_delete_by_key::group_key"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">group_key
</span></code></a> without any terminating zero
</p></li>
216 <li><p><strong>key
</strong> -- the key to delete
</p></li>
217 <li><p><strong>key_length
</strong> -- the length og the
<a class=
"reference internal" href=
"#_CPPv423memcached_delete_by_keyP12memcached_stPKc6size_tPKc6size_t6time_t" title=
"memcached_delete_by_key::key"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">key
</span></code></a> without any terminating zero
</p></li>
218 <li><p><strong>expiration
</strong> -- obsolete since
<em class=
"manpage"><a class=
"manpage reference external" href=
"https://linux.die.net/man/1/memcached">memcached(
1)
</a></em> version
1.4</p></li>
221 <dt class=
"field-even">Returns
</dt>
222 <dd class=
"field-even"><p><a class=
"reference internal" href=
"memcached_return_t.html#_CPPv418memcached_return_t" title=
"memcached_return_t"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_return_t
</span></code></a> indicating success
</p>
228 <div class=
"section" id=
"description">
229 <h2>DESCRIPTION
<a class=
"headerlink" href=
"#description" title=
"Permalink to this headline">¶
</a></h2>
230 <p><a class=
"reference internal" href=
"#_CPPv416memcached_deleteP12memcached_stPKc6size_t6time_t" title=
"memcached_delete"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_delete()
</span></code></a> is used to delete a particular key.
<a class=
"reference internal" href=
"#_CPPv423memcached_delete_by_keyP12memcached_stPKc6size_tPKc6size_t6time_t" title=
"memcached_delete_by_key"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_delete_by_key()
</span></code></a>
231 works the same, but it takes a master key to find the given value.
</p>
232 <p>Expiration works by placing the item into a delete queue, which means that it
233 won't be possible to retrieve it by the
"get
" command. The
"add
" and
"replace
"
234 commands with this key will also fail (the
"set
" command will succeed, however).
235 After the time passes, the item is finally deleted from server memory.
</p>
236 <p>Please note the the memcached server removed tests for expiration in the
1.4
239 <div class=
"section" id=
"return-value">
240 <h2>RETURN VALUE
<a class=
"headerlink" href=
"#return-value" title=
"Permalink to this headline">¶
</a></h2>
241 <p>A value of type
<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> is returned
242 On success that value will be
<a class=
"reference internal" href=
"memcached_return_t.html#_CPPv4N18memcached_return_t17MEMCACHED_SUCCESSE" title=
"MEMCACHED_SUCCESS"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">MEMCACHED_SUCCESS
</span></code></a>.
243 Use
<a class=
"reference internal" href=
"memcached_strerror.html#_CPPv418memcached_strerrorP12memcached_st18memcached_return_t" title=
"memcached_strerror"><code class=
"xref cpp cpp-any docutils literal notranslate"><span class=
"pre">memcached_strerror()
</span></code></a> to translate this value to a printable string.
</p>
244 <p>If you are using the non-blocking mode of the library, success only means that
245 the message was queued for delivery.
</p>
247 <div class=
"section" id=
"see-also">
248 <h2>SEE ALSO
<a class=
"headerlink" href=
"#see-also" title=
"Permalink to this headline">¶
</a></h2>
250 <li><p><em class=
"manpage"><a class=
"manpage reference external" href=
"https://linux.die.net/man/1/memcached">memcached(
1)
</a></em></p></li>
251 <li><p><a class=
"reference internal" href=
"../libmemcached.html"><span class=
"doc">C/C++ Client Library for memcached
</span></a></p></li>
252 <li><p><a class=
"reference internal" href=
"memcached_strerror.html"><span class=
"doc">Converting Error Codes to Messages
</span></a></p></li>
263 <div class=
"rst-footer-buttons" role=
"navigation" aria-label=
"footer navigation">
265 <a href=
"memcached_quit.html" class=
"btn btn-neutral float-right" title=
"Disconnecting a client from a server" accesskey=
"n" rel=
"next">Next
<span class=
"fa fa-arrow-circle-right"></span></a>
268 <a href=
"memcached_set.html" class=
"btn btn-neutral float-left" title=
"Storing data on the server" accesskey=
"p" rel=
"prev"><span class=
"fa fa-arrow-circle-left"></span> Previous
</a>
275 <div role=
"contentinfo">
279 © <a href=
"../copyright.html">Copyright
</a>
286 Built with
<a href=
"http://sphinx-doc.org/">Sphinx
</a> using a
288 <a href=
"https://github.com/rtfd/sphinx_rtd_theme">theme
</a>
290 provided by
<a href=
"https://readthedocs.org">Read the Docs
</a>.
302 <script type=
"text/javascript">
304 SphinxRtdTheme.Navigation.enable(true);