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