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

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