.TH "HASHKIT_IS_ALLOCATED" "3" "June 17, 2011" "0.49" "libmemcached"
.SH NAME
hashkit_is_allocated \- libhashkit Documentation
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.
.SH SYNOPSIS
.sp
#include <libhashkit/hashkit.h>
.INDENT 0.0
.TP
.B hashkit_st *hashkit_create(hashkit_st *hash);
.UNINDENT
.INDENT 0.0
.TP
.B hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
.UNINDENT
.INDENT 0.0
.TP
.B void hashkit_free(hashkit_st *hash);
.UNINDENT
.INDENT 0.0
.TP
.B bool hashkit_is_allocated(const hashkit_st *hash);
.UNINDENT
.sp
Compile and link with \-lhashkit
.SH DESCRIPTION
.sp
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.
.sp
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.
.sp
The hashkit_free() frees any resources being consumed by the hashkit
objects that were initialized with hashkit_create() or hashkit_clone().
.sp
The hashkit_is_allocated() reports where the memory was allocated
for a hashkit object.
.SH RETURN VALUE
.sp
hashkit_create() and hashkit_clone() will return NULL on failure or
non\-NULL on success.
.sp
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.
.SH HOME
.sp
To find out more information please check:
\fI\%http://libmemcached.org/\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\" 
.