X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;ds=sidebyside;f=libhashkit%2Fhashkit_create.html;h=c85148d860dca81e05d2f8ac06e99a7742843c4d;hb=cffe0635412a614ab01705628d406918b0ade7fe;hp=c52a3e69ef21a2d9977cf65e011558a1225cfd15;hpb=c6fde8b6a27b6af31f0cf26a9cdccd54cd25734a;p=awesomized%2Flibmemcached diff --git a/libhashkit/hashkit_create.html b/libhashkit/hashkit_create.html index c52a3e69..c85148d8 100644 --- a/libhashkit/hashkit_create.html +++ b/libhashkit/hashkit_create.html @@ -8,7 +8,7 @@ -
Compile and link with -lhashkit
-hashkit_st
¶hashkit_st
¶hashkit_create
(hashkit_st *hash)¶hashkit_create
(hashkit_st *hash)¶Parameters: | hash -- memory address of a hashkit_st struct;
+if a nullptr is passed, the struct will be dynamically allocated by libhashkit |
+
---|---|
Returns: | pointer to initialized hashkit_st structure |
+
hashkit_clone
(hashkit_st *destination, const hashkit_st *ptr)¶hashkit_clone
(hashkit_st *destination, const hashkit_st *ptr)¶Parameters: |
|
+
---|---|
Returns: | pointer to a |
+
hashkit_free
(hashkit_st *hash)¶hashkit_free
(hashkit_st *hash)¶Parameters: | hash -- pointer to an initialized hashkit_st struct |
+
---|
hashkit_is_allocated
(const hashkit_st *hash)¶hashkit_is_allocated
(const hashkit_st *hash)¶Parameters: | hash -- pointer to an initialized hashkit_st struct |
+
---|---|
Returns: | bool, whether the hash struct was dynamically allocated |
+
The hashkit_create()
function initializes a hashkit object for use. If you pass
-a NULL argument for hash, then the memory for the object is allocated. If you
+a nullptr argument for hash, then the memory for the object is allocated. If you
specify a pre-allocated piece of memory, that is initialized for use.
The hashkit_clone()
function initializes a hashkit object much like
hashkit_create()
, but instead of using default settings it will use the settings
of the ptr hashkit object.
The hashkit_free()
frees any resources being consumed by the hashkit objects
that were initialized with hashkit_create()
or hashkit_clone()
.
The hashkit_is_allocated()
reports where the memory was allocated for a hashkit
+
The hashkit_is_allocated()
reports whether the memory was allocated for a hashkit
object.
hashkit_create()
and hashkit_clone()
will return NULL on failure or non-NULL on
-success.
hashkit_create()
and hashkit_clone()
will return nullptr on failure or pointer
+to hashkit_st
on success.
hashkit_is_allocated()
returns true if the memory for the hashkit object was
allocated inside of hashkit_create()
or hashkit_clone()
, otherwise it is false
and was user-supplied memory.