X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fsource%2Flibhashkit%2Fhashkit_create.rst;h=630ee0a4b8227b9693733881d1dcda8061b86f90;hb=bdf3398dac90a54d82aed65099290d51e92d4601;hp=b11f6420023f2d859e67c23019259f403bab2814;hpb=28c4d79e109e11d7d2a9f3189de57da28302ec68;p=m6w6%2Flibmemcached diff --git a/docs/source/libhashkit/hashkit_create.rst b/docs/source/libhashkit/hashkit_create.rst index b11f6420..630ee0a4 100644 --- a/docs/source/libhashkit/hashkit_create.rst +++ b/docs/source/libhashkit/hashkit_create.rst @@ -34,13 +34,13 @@ the settings of the ptr hashkit object. The :func:`hashkit_free` frees any resources being consumed by the hashkit objects that were initialized with :func:`hashkit_create` or :func:`hashkit_clone`. -The :func:`hashkit_is_allocated` reports where the memory was allocated +The :func:`hashkit_is_allocated` reports where the memory was allocated for a hashkit object. RETURN VALUE ------------ -:func:`hashkit_create` and :func:`hashkit_clone` will return NULL on +:func:`hashkit_create` and :func:`hashkit_clone` will return NULL on failure or non-NULL on success. :func:`hashkit_is_allocated` returns true if the memory for the hashkit