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

   1 .. highlight:: perl
   2
   3
   4 ****
   5 NAME
   6 ****
   7
   8
   9 memcached_set_user_data, memcached_get_user_data - Manage user specific data
  10
  11
  12 *******
  13 LIBRARY
  14 *******
  15
  16
  17 C Client Library for memcached (libmemcached, -lmemcached)
  18
  19
  20 ********
  21 SYNOPSIS
  22 ********
  23
  24
  25
  26 .. code-block:: perl
  27
  28    #include <memcached.h>
  29
  30    void *memcached_get_user_data (memcached_st *ptr);
  31
  32    void *memcached_set_user_data (memcached_st *ptr, void *data);
  33
  34
  35
  36 ***********
  37 DESCRIPTION
  38 ***********
  39
  40
  41 libmemcached(3) allows you to store a pointer to a user specific data inside
  42 the memcached_st structure.
  43
  44 memcached_set_user_data() is used to set the user specific data in the
  45 memcached_st structure.
  46
  47 memcached_get_user_data() is used to retrieve the user specific data in
  48 the memcached_st structure.
  49
  50
  51 ******
  52 RETURN
  53 ******
  54
  55
  56 memcached_set_user_data() returns the previous value of the user specific
  57 data.
  58
  59 memcached_get_user_data() returns the current value uf the user specific
  60 data.
  61
  62
  63 ****
  64 HOME
  65 ****
  66
  67
  68 To find out more information please check:
  69 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
  70
  71
  72 ******
  73 AUTHOR
  74 ******
  75
  76
  77 Trond Norbye, <trond.norbye@gmail.com>
  78
  79
  80 ********
  81 SEE ALSO
  82 ********
  83
  84
  85 memcached(1) libmemcached(3)
  86