void* pblHtFirst

( pblHashTable_t* h )

Get data of first key in hash table.

Documentation

Get data of first key in hash table.

This call and pblHtNext can be used in order to loop through all items stored in a hash table.

   Example:

   for( data = pblHtFirst( h ); data; data = pblHtNext( h ))
   {
       do something with the data pointer
   }
   

Parameters:

h - Hash table to look in

Returns:

void * retptr != NULL: The pointer to data of first item.
void * retptr == NULL: An error, see pbl_errno:
PBL_ERROR_NOT_FOUND - The hash table is empty.

Alphabetic index