docs: sanitize
[awesomized/libmemcached] / docs / source / libmemcached / memcached_exist.rst
1 ===========================
2 Determine if a keys exists.
3 ===========================
4
5 .. index:: object: memcached_st
6
7 --------
8 SYNOPSIS
9 --------
10
11
12 #include <libmemcached/memcached.h>
13
14 .. c:function:: memcached_return_t memcached_exist(memcached_st *ptr, char *key, size_t *key_length)
15
16 .. c:function:: memcached_return_t memcached_exist_by_key(memcached_st *ptr, char *group_key, size_t *group_key_length, char *key, size_t *key_length)
17
18 Compile and link with -lmemcached
19
20 .. versionadded:: 0.53
21
22
23 -----------
24 DESCRIPTION
25 -----------
26
27 :c:func:`memcached_exist()` can be used to check if a key exists.
28
29
30 ------
31 RETURN
32 ------
33
34 :c:type:`MEMCACHED_SUCCESS`
35 The key exists.
36
37 :c:type:`MEMCACHED_NOTFOUND`
38 The key was not found.
39
40 --------
41 SEE ALSO
42 --------
43
44
45 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
46
47