X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=libhashkit%2Fhashkit_create.html;h=c52a3e69ef21a2d9977cf65e011558a1225cfd15;hb=c6fde8b6a27b6af31f0cf26a9cdccd54cd25734a;hp=ec4507a4feedf969b866a71bc87474f686cc326c;hpb=203265989899a9a2a5433c870799d0d5bc1e103e;p=m6w6%2Flibmemcached diff --git a/libhashkit/hashkit_create.html b/libhashkit/hashkit_create.html index ec4507a4..c52a3e69 100644 --- a/libhashkit/hashkit_create.html +++ b/libhashkit/hashkit_create.html @@ -180,7 +180,6 @@

Creating a hashkit structure¶

-

Create, copy and free a hashkit structure

SYNOPSIS¶

@@ -215,25 +214,24 @@

DESCRIPTION¶

-

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 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 object.

+

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 +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 +object.

RETURN VALUE¶

-

hashkit_create() and hashkit_clone() will return NULL on -failure or non-NULL 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.

+

hashkit_create() and hashkit_clone() will return NULL on failure or non-NULL 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.

SEE ALSO¶