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 SYNOPSIS
8 --------
9
10 #include <libmemcached/memcached.h>
11
12 .. function:: memcached_return_t memcached_exist(memcached_st *ptr, char *key, size_t *key_length)
13
14 .. 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)
15
16 Compile and link with -lmemcached
17
18 .. versionadded:: 0.53
19
20 DESCRIPTION
21 -----------
22
23 :func:`memcached_exist()` can be used to check if a key exists.
24
25 RETURN
26 ------
27
28 `MEMCACHED_SUCCESS`
29 The key exists.
30
31 `MEMCACHED_NOTFOUND`
32 The key was not found.
33
34 SEE ALSO
35 --------
36
37 .. only:: man
38
39 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
40