Merge lp:~tangent-org/libmemcached/1.0-build/ Build: jenkins-Libmemcached-187
[m6w6/libmemcached] / docs / hashkit_value.rst
1 =============
2 hashkit_value
3 =============
4
5
6 .. index:: object: hashkit_st
7
8 Generate a value for the given key
9
10 --------
11 SYNOPSIS
12 --------
13
14
15 #include <libhashkit/hashkit.h>
16
17 .. c:function:: uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length)
18
19 Compile and link with -lhashkit
20
21 -----------
22 DESCRIPTION
23 -----------
24
25
26 The :c:func:`hashkit_value` function generates a 32-bit hash value from the
27 given key and key_length. The hash argument is an initialized hashkit
28 object, and distribution type and hash function is used from this
29 object while generating the value.
30
31
32 ------------
33 RETURN VALUE
34 ------------
35
36
37 A 32-bit hash value.
38
39
40 ----
41 HOME
42 ----
43
44
45 To find out more information please check:
46 `http://libmemcached.org/ <http://libmemcached.org/>`_
47
48
49 --------
50 SEE ALSO
51 --------
52
53
54 :manpage:`hashkit_create(3)` :manpage:`hashkit_set_distribution(3)` :manpage:`hashkit_set_hash_fn(3)`
55