prg_string_hash_table_keys_get()
Abstract
Returns a list of all the keys in a hash table.
Syntax
prg_string_hash_table_keys_get (hash_table_ptr)
| Argument | Type | Description |
|---|---|---|
hash_table_ptr |
PrgT_Sting_Hash_Table * |
Pointer to the hash table of interest. |
Return Type
PrgT_List *
List of all the keys in the hash table.
Header
prg_string_hash_funcs.h
Details
This function returns a list of keys that have been inserted into the hash table. Typically, this is used to efficiently iterate over all of the objects contained in the hash table.
This function returns allocated copies of the key strings in the hash table. Thus, the client must destroy both the returned key strings and list when no longer needed. Failure to do so can lead to memory leaks.
WARNING: This function is MT unsafe, as described in “Multi-Threading Safety“ on page 11. Access to shared hash tables must be externally serialized.