Fixed autoconf macros for cross compile
[awesomized/libmemcached] / docs / hashkit_create.pod
1 =head1 NAME
2
3 hashkit_create, hashkit_clone, hashkit_free, hashkit_is_allocated -
4 Create and destroy hashkit objects
5
6 =head1 LIBRARY
7
8 C Library for hashing algorithms (libhashkit, -lhashkit)
9
10 =head1 SYNOPSIS
11
12 #include <libhashkit/hashkit.h>
13
14 hashkit_st *hashkit_create(hashkit_st *hash);
15
16 hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
17
18 void hashkit_free(hashkit_st *hash);
19
20 bool hashkit_is_allocated(const hashkit_st *hash);
21
22 =head1 DESCRIPTION
23
24 The hashkit_create() function initializes a hashkit object for use. If
25 you pass a NULL argument for hash, then the memory for the object is
26 allocated. If you specify a pre-allocated piece of memory, that is
27 initialized for use.
28
29 The hashkit_clone() function initializes a hashkit object much like
30 hashkit_create(), but instead of using default settings it will use
31 the settings of the ptr hashkit object.
32
33 The hashkit_free() frees any resources being consumed by the hashkit
34 objects that were initialized with hashkit_create() or hashkit_clone().
35
36 The hashkit_is_allocated() reports where the memory was allocated
37 for a hashkit object.
38
39 =head1 RETURN VALUE
40
41 hashkit_create() and hashkit_clone() will return NULL on failure or
42 non-NULL on success.
43
44 hashkit_is_allocated() returns true if the memory for the hashkit
45 object was allocated inside of hashkit_create() or hashkit_clone(),
46 otherwise it is false and was user-supplied memory.
47
48 =head1 HOME
49
50 To find out more information please check:
51 L<https://launchpad.net/libmemcached>
52
53 =head1 AUTHOR
54
55 Brian Aker, E<lt>brian@tangent.orgE<gt>
56
57 =cut