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