pl_hashtableenumerateentries.rst (831B)
1 PL_HashTableEnumerateEntries 2 ============================ 3 4 Enumerates all the entries in the hash table, invoking a specified 5 function on each entry. 6 7 8 Syntax 9 ------ 10 11 .. code:: 12 13 #include <plhash.h> 14 15 PRIntn PL_HashTableEnumerateEntries( 16 PLHashTable *ht, 17 PLHashEnumerator f, 18 void *arg); 19 20 21 Parameters 22 ~~~~~~~~~~ 23 24 The function has the following parameters: 25 26 ``ht`` 27 A pointer to the hash table whose entries are to be enumerated. 28 ``f`` 29 Function to be applied to each entry. 30 ``arg`` 31 Argument for function ``f``. 32 33 34 Returns 35 ~~~~~~~ 36 37 The number of entries enumerated. 38 39 40 Description 41 ----------- 42 43 The entries are enumerated in an unspecified order. For each entry, the 44 enumerator function is invoked with the entry, the index (in the 45 sequence of enumeration, starting from 0) of the entry, and arg as 46 arguments.