git.m6w6.name Git - awesomized/libmemcached/blob - docs/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    .. versionadded:: 0.53
  19
  20 Compile and link with -lmemcached
  21
  22
  23 -----------
  24 DESCRIPTION
  25 -----------
  26
  27 :c:func:`memcached_exist()` can be used to check to see if a key exists. No value is returned if the key exists, or does not exist, on the server.
  28
  29
  30 ------
  31 RETURN
  32 ------
  33
  34 :c:func:`memcached_exist()` sets error to
  35 to :c:type:`MEMCACHED_SUCCESS` upon finding that the key exists.
  36 :c:type:`MEMCACHED_NOTFOUND` will be return if the key is not found.
  37
  38
  39 ----
  40 HOME
  41 ----
  42
  43 To find out more information please check:
  44 `http://libmemcached.org/ <http://libmemcached.org/>`_
  45
  46
  47 --------
  48 SEE ALSO
  49 --------
  50
  51 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
  52
  53