42
.B hashkit_st *hashkit_create(hashkit_st *hash);
46
.B hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
50
.B void hashkit_free(hashkit_st *hash);
54
.B bool hashkit_is_allocated(const hashkit_st *hash);
42
.B \fI\%hashkit_st\fP *hashkit_create(\fI\%hashkit_st\fP\fI\ *hash\fP)
46
.B \fI\%hashkit_st\fP *hashkit_clone(\fI\%hashkit_st\fP\fI\ *destination\fP, const \fI\%hashkit_st\fP\fI\ *ptr\fP)
50
.B void hashkit_free(\fI\%hashkit_st\fP\fI\ *hash\fP)
54
.B bool hashkit_is_allocated(const \fI\%hashkit_st\fP\fI\ *hash\fP)
57
57
Compile and link with \-lhashkit
60
The \fBhashkit_create()\fP function initializes a hashkit object for use. If
60
The \fI\%hashkit_create()\fP function initializes a hashkit object for use. If
61
61
you pass a NULL argument for hash, then the memory for the object is
62
62
allocated. If you specify a pre\-allocated piece of memory, that is
63
63
initialized for use.
65
The \fBhashkit_clone()\fP function initializes a hashkit object much like
66
\fBhashkit_create()\fP, but instead of using default settings it will use
65
The \fI\%hashkit_clone()\fP function initializes a hashkit object much like
66
\fI\%hashkit_create()\fP, but instead of using default settings it will use
67
67
the settings of the ptr hashkit object.
69
The \fBhashkit_free()\fP frees any resources being consumed by the hashkit
70
objects that were initialized with \fBhashkit_create()\fP or \fBhashkit_clone()\fP.
69
The \fI\%hashkit_free()\fP frees any resources being consumed by the hashkit
70
objects that were initialized with \fI\%hashkit_create()\fP or \fI\%hashkit_clone()\fP.
72
The \fBhashkit_is_allocated()\fP reports where the memory was allocated
72
The \fI\%hashkit_is_allocated()\fP reports where the memory was allocated
73
73
for a hashkit object.
76
\fBhashkit_create()\fP and \fBhashkit_clone()\fP will return NULL on
76
\fI\%hashkit_create()\fP and \fI\%hashkit_clone()\fP will return NULL on
77
77
failure or non\-NULL on success.
79
\fBhashkit_is_allocated()\fP returns true if the memory for the hashkit
80
object was allocated inside of \fBhashkit_create()\fP or
81
\fBhashkit_clone()\fP, otherwise it is false and was user\-supplied memory.
79
\fI\%hashkit_is_allocated()\fP returns true if the memory for the hashkit
80
object was allocated inside of \fI\%hashkit_create()\fP or
81
\fI\%hashkit_clone()\fP, otherwise it is false and was user\-supplied memory.
84
84
To find out more information please check:
added
removed
docs/man/hashkit_create.3
