git.m6w6.name Git - awesomized/libmemcached/blob - docs/source/libmemcached/memcached_touch.rst

   1 ===========================================
   2 memcached_touch, memcached_touch_by_key
   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_touch (memcached_st *ptr, const char *key, size_t key_length, time_t expiration)
  14
  15 .. function:: memcached_return_t memcached_touch_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration)
  16
  17 Compile and link with -lmemcached
  18
  19 -----------
  20 DESCRIPTION
  21 -----------
  22
  23 :func:`memcached_touch` is used to update the expiration time on an existing key.
  24 :func:`memcached_touch_by_key` works the same, but it takes a master key
  25 to find the given value.
  26
  27 ------
  28 RETURN
  29 ------
  30
  31 A value of type :type:`memcached_return_t` is returned
  32 On success that value will be `MEMCACHED_SUCCESS`.
  33 Use :func:`memcached_strerror` to translate this value to a printable
  34 string.
  35
  36 --------
  37 SEE ALSO
  38 --------
  39
  40 .. only:: man
  41
  42   :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
  43