Returns an iterator object that can be used to enumerate all of the values associated with the specified key.
#include "am_map.h" AM_EXPORT am_status_t am_map_find(am_map_t map, const char *key, am_map_value_iter_t *value_iter_ptr);
This function takes the following parameters:
The handle for the map object to be examined.
The key for the entry to look up.
Pointer to where the handle for the new value iterator object should be stored.
This function returns am_status_t with one of the following values:
If no error was detected.
If unable to allocate memory for the value iterator object.
If the value_iter_ptr argument is NULL.
If the specified key could not be found in the map.
This function takes a key and returns an iterator that iterates over the values associated with the key.
If the value_iter_ptr argument is non-NULL, then the location that it refers to will be set to NULL if an error is returned.
Memory Concerns: At the end of usage of value_iter_ptr, the caller must call am_map_value_iter_destroy with the iterators pointer.