prg_bin_hash_table_item_list_get()
Abstract
Gets a list of the items in a hash table.
Syntax
prg_bin_hash_table_item_list_get (hash_ptr)
| Argument | Type | Description |
|---|---|---|
hash_ptr |
PrgT_Bin_Hash_Table * |
Hash table of interest. |
Return Type
PrgT_List *
List of items in the hash table; PRGC_NIL if the table is empty or an error occurs.
Header
prg_bin_hash.h
Details
This function creates a list and populates it with pointers to the items in the hash table. This is an O(N+M) operation, where N is the number of cells and M is the number of items. This function is intended to support iterating over all of the items in a hash table.
The returned list is created by this function and owned by the caller. The items in the list are pointers to the items in the hash table and should not be freed without first removing the items from the table.
WARNING: This function is MT unsafe, as described in “Multi-Threading Safety“ on page 11. Access to shared hash tables must be externally serialized.