← Back to branch summary

~kent/libmemcached/KBDocs4

« back to all changes in this revision

Viewing changes to docs/man/hashkit_free.3

Merge in all of build.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/hashkit_free.3
 
1
.TH "HASHKIT_FREE" "3" "April 09, 2011" "0.47" "libmemcached"
 
2
.SH NAME
 
3
hashkit_free \- libhashkit Documentation
 
4
.
 
5
.nr rst2man-indent-level 0
 
6
.
 
7
.de1 rstReportMargin
 
8
\\$1 \\n[an-margin]
 
9
level \\n[rst2man-indent-level]
 
10
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 
11
-
 
12
\\n[rst2man-indent0]
 
13
\\n[rst2man-indent1]
 
14
\\n[rst2man-indent2]
 
15
..
 
16
.de1 INDENT
 
17
.\" .rstReportMargin pre:
 
18
. RS \\$1
 
19
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
 
20
. nr rst2man-indent-level +1
 
21
.\" .rstReportMargin post:
 
22
..
 
23
.de UNINDENT
 
24
. RE
 
25
.\" indent \\n[an-margin]
 
26
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
 
27
.nr rst2man-indent-level -1
 
28
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 
29
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 
30
..
 
31
.\" Man page generated from reStructeredText.
 
32
.
 
33
.sp
 
34
Create and destroy hashkit objects
 
35
.SH LIBRARY
 
36
.sp
 
37
C Library for hashing algorithms (libmemcached, \-lhashkit)
 
38
.SH SYNOPSIS
 
39
.sp
 
40
.nf
 
41
.ft C
 
42
#include <libmemcached/hashkit.h>
 
43
 
 
44
hashkit_st *hashkit_create(hashkit_st *hash);
 
45
 
 
46
hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
 
47
 
 
48
void hashkit_free(hashkit_st *hash);
 
49
 
 
50
bool hashkit_is_allocated(const hashkit_st *hash);
 
51
.ft P
 
52
.fi
 
53
.SH DESCRIPTION
 
54
.sp
 
55
The hashkit_create() function initializes a hashkit object for use. If
 
56
you pass a NULL argument for hash, then the memory for the object is
 
57
allocated. If you specify a pre\-allocated piece of memory, that is
 
58
initialized for use.
 
59
.sp
 
60
The hashkit_clone() function initializes a hashkit object much like
 
61
hashkit_create(), but instead of using default settings it will use
 
62
the settings of the ptr hashkit object.
 
63
.sp
 
64
The hashkit_free() frees any resources being consumed by the hashkit
 
65
objects that were initialized with hashkit_create() or hashkit_clone().
 
66
.sp
 
67
The hashkit_is_allocated() reports where the memory was allocated
 
68
for a hashkit object.
 
69
.SH RETURN VALUE
 
70
.sp
 
71
hashkit_create() and hashkit_clone() will return NULL on failure or
 
72
non\-NULL on success.
 
73
.sp
 
74
hashkit_is_allocated() returns true if the memory for the hashkit
 
75
object was allocated inside of hashkit_create() or hashkit_clone(),
 
76
otherwise it is false and was user\-supplied memory.
 
77
.SH HOME
 
78
.sp
 
79
To find out more information please check:
 
80
\fI\%https://launchpad.net/libmemcached\fP
 
81
.SH AUTHOR
 
82
Brian Aker
 
83
.SH COPYRIGHT
 
84
2011, Brian Aker DataDifferential, http://datadifferential.com/
 
85
.\" Generated by docutils manpage writer.
 
86
.\" 
 
87
.