1 .TH "HASHKIT_IS_ALLOCATED" "3" "June 17, 2011" "0.49" "libmemcached"
3 hashkit_is_allocated \- 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.
35 #include <libhashkit/hashkit.h>
38 .B hashkit_st *hashkit_create(hashkit_st *hash);
42 .B hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
46 .B void hashkit_free(hashkit_st *hash);
50 .B bool hashkit_is_allocated(const hashkit_st *hash);
53 Compile and link with \-lhashkit
56 The hashkit_create() function initializes a hashkit object for use. If
57 you pass a NULL argument for hash, then the memory for the object is
58 allocated. If you specify a pre\-allocated piece of memory, that is
61 The hashkit_clone() function initializes a hashkit object much like
62 hashkit_create(), but instead of using default settings it will use
63 the settings of the ptr hashkit object.
65 The hashkit_free() frees any resources being consumed by the hashkit
66 objects that were initialized with hashkit_create() or hashkit_clone().
68 The hashkit_is_allocated() reports where the memory was allocated
72 hashkit_create() and hashkit_clone() will return NULL on failure or
75 hashkit_is_allocated() returns true if the memory for the hashkit
76 object was allocated inside of hashkit_create() or hashkit_clone(),
77 otherwise it is false and was user\-supplied memory.
80 To find out more information please check:
81 \fI\%http://libmemcached.org/\fP
85 2011, Brian Aker DataDifferential, http://datadifferential.com/
86 .\" Generated by docutils manpage writer.