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

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