pl_hashstring.rst (488B)
1 PL_HashString 2 ============= 3 4 A general-purpose hash function for character strings. 5 6 7 Syntax 8 ------ 9 10 .. code:: 11 12 #include <plhash.h> 13 14 PLHashNumber PL_HashString(const void *key); 15 16 17 Parameter 18 ~~~~~~~~~ 19 20 The function has the following parameter: 21 22 ``key`` 23 A pointer to a character string. 24 25 26 Returns 27 ~~~~~~~ 28 29 The hash number for the specified key. 30 31 32 Description 33 ----------- 34 35 :ref:`PL_HashString` can be used as the key hash function for a hash table 36 if the key is a character string.