X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Flibmemcached%2Fmemcached_exist.rst;h=d93a220558e1b3a3651d0d75848038dba805547a;hb=3cddec3d3b13326ee72b6376081254e32ec1483d;hp=7dc29e954894b99ea9e86bea99624d953e19c0d6;hpb=e1833e25ab4a98f9a3f9f9268185af57b2280eaf;p=awesomized%2Flibmemcached diff --git a/docs/source/libmemcached/memcached_exist.rst b/docs/source/libmemcached/memcached_exist.rst index 7dc29e95..d93a2205 100644 --- a/docs/source/libmemcached/memcached_exist.rst +++ b/docs/source/libmemcached/memcached_exist.rst @@ -1,32 +1,32 @@ -=========================== -Determine if a keys exists. -=========================== +Determine if a keys exists +========================== -.. index:: object: memcached_st - --------- SYNOPSIS -------- #include + Compile and link with -lmemcached .. function:: memcached_return_t memcached_exist(memcached_st *ptr, char *key, size_t *key_length) .. 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) -Compile and link with -lmemcached + :param ptr: pointer to an initialized `memcached_st` struct + :param group_key: the key namespace + :param group_key_length: length of the `group_key` without any terminating zero + :param key: the key to check + :param key_length: length of the `key` without any terminating zero + :returns: `memcached_return_t` indicating success .. versionadded:: 0.53 ------------ DESCRIPTION ----------- :func:`memcached_exist()` can be used to check if a key exists. ------- -RETURN ------- +RETURN VALUE +------------ `MEMCACHED_SUCCESS` The key exists. @@ -34,11 +34,17 @@ RETURN `MEMCACHED_NOTFOUND` The key was not found. --------- SEE ALSO -------- .. only:: man - :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + :manpage:`memcached(1)` + :manpage:`libmemcached(3)` + :manpage:`memcached_strerror(3)` + +.. only:: html + * :manpage:`memcached(1)` + * :doc:`../libmemcached` + * :doc:`memcached_strerror`