axl main logo
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Modules Pages
typedef axl_bool(* axlHashForeachFunc)(axlPointer key, axlPointer data, axlPointer user_data)

Foreach function signature used to represent the set of functions used at axl_hash_foreach.

The function receives the item found (key and data values) as well as a user defined pointer also defined at axl_hash_foreach. The function must return axl_true ("item found") to make the search to stop. In the case a full iteration over all items inside the hash is required, the function must always return axl_false.

keyThe key for the item stored.
dataThe data associated to the key found
user_dataUser defined data that was provided to the axl_hash_foreach function.
axl_true to make the foreach process to stop. axl_false to make the process to continue.