git.m6w6.name Git - awesomized/libmemcached/blob - docs/libmemcached-1.0/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
  12 #include <libmemcached/memcached.h>
  13
  14 .. c:function:: memcached_return_t memcached_touch (memcached_st *ptr, const char *key, size_t key_length, time_t expiration)
  15
  16 .. c: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)
  17
  18 Compile and link with -lmemcached
  19
  20 -----------
  21 DESCRIPTION
  22 -----------
  23
  24
  25 :c:func:`memcached_touch` is used to update the expiration time on an existing key.
  26 :c:func:`memcached_touch_by_key` works the same, but it takes a master key
  27 to find the given value.
  28
  29
  30 ------
  31 RETURN
  32 ------
  33
  34
  35 A value of type :c:type:`memcached_return_t` is returned
  36 On success that value will be :c:type:`MEMCACHED_SUCCESS`.
  37 Use :c:func:`memcached_strerror` to translate this value to a printable
  38 string.
  39
  40 ----
  41 HOME
  42 ----
  43
  44 To find out more information please check:
  45 `http://libmemcached.org/ <http://libmemcached.org/>`_
  46
  47
  48 ------
  49 AUTHOR
  50 ------
  51
  52
  53 Brian Aker, <brian@tangent.org>
  54
  55
  56 --------
  57 SEE ALSO
  58 --------
  59
  60 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
  61