-
Notifications
You must be signed in to change notification settings - Fork 0
/
ght_next_keysize.3
45 lines (34 loc) · 1.26 KB
/
ght_next_keysize.3
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
.TH ght_next_keysize 3 "2007-07-15" "libghthash" "libghthash User Manual"
.SH NAME
ght_next_keysize \- return the next element in an iteration
.SH SYNOPSIS
.B #include <ght_hash_table.h>
.BI "void *ght_next_keysize(ght_hash_table_t *" p_ht ", ght_iterator_t *" p_it", void **" pp_key ", unsigned int *" size ");"
.SH DESCRIPTION
Return the next element in an iteration.
.I p_ht
is the hash table to iterate in,
.I p_it
is a pointer to the iterator to initialize, and
.I pp_key
is filled in with a pointer to the key for the current item.
.I size
is filled in with the size for this key
This function should be used for iteration, and must be called after
.I ght_first_keysize() or .I ght_first().
The use of the
.I ght_iterator_t
allows for several concurrent iterations, where you would use one
.I ght_iterator_t
for each iteration. In threaded environments, you should still lock access to
the hash table for insertion and removal.
.SH WARNING
Calling this without first having called
.I ght_first
will give undefined results (probably a crash), since the iterator isn't
filled correctly.
.SH SEE ALSO
.BR ght_first_keysize (3),
libghthash is fully documented with Doxygen (in {prefix}/doc/libghthash/html/).
.SH AUTHOR
This manual page was created by Simon Kagstrom <[email protected]>.