1 .TH "HASHKIT_CREATE" "3" "April 13, 2011" "0.47" "libmemcached"
3 hashkit_create \- libhashkit Documentation
5 .nr rst2man-indent-level 0
9 level \\n[rst2man-indent-level]
10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
17 .\" .rstReportMargin pre:
19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20 . nr rst2man-indent-level +1
21 .\" .rstReportMargin post:
25 .\" indent \\n[an-margin]
26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27 .nr rst2man-indent-level -1
28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
31 .\" Man page generated from reStructeredText.
34 Create and destroy hashkit objects
37 C Library for hashing algorithms (libmemcached, \-lhashkit)
42 #include <libmemcached/hashkit.h>
44 hashkit_st *hashkit_create(hashkit_st *hash);
46 hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
48 void hashkit_free(hashkit_st *hash);
50 bool hashkit_is_allocated(const hashkit_st *hash);
55 The hashkit_create() function initializes a hashkit object for use. If
56 you pass a NULL argument for hash, then the memory for the object is
57 allocated. If you specify a pre\-allocated piece of memory, that is
60 The hashkit_clone() function initializes a hashkit object much like
61 hashkit_create(), but instead of using default settings it will use
62 the settings of the ptr hashkit object.
64 The hashkit_free() frees any resources being consumed by the hashkit
65 objects that were initialized with hashkit_create() or hashkit_clone().
67 The hashkit_is_allocated() reports where the memory was allocated
71 hashkit_create() and hashkit_clone() will return NULL on failure or
74 hashkit_is_allocated() returns true if the memory for the hashkit
75 object was allocated inside of hashkit_create() or hashkit_clone(),
76 otherwise it is false and was user\-supplied memory.
79 To find out more information please check:
80 \fI\%https://launchpad.net/libmemcached\fP
84 2011, Brian Aker DataDifferential, http://datadifferential.com/
85 .\" Generated by docutils manpage writer.