am_map_entry_iter_get_values()

Returns an iterator object that can be used to enumerate all of the values associated with the entry referenced by the iterator you specify.

Syntax

#include "am_map.h"
AM_EXPORT am_status_t
am_map_entry_iter_get_values(am_map_entry_iter_t entry_iter,

Parameters

This function takes the following parameters:

entry_iter

The handle for the entry iterator object to be examined.

value_iter_ptr

Pointer to where the handle for the new value iterator object should be stored.

Returns

This function returns am_status_t with one of the following values:

AM_SUCCESS

If no error was detected.

AM_NO_MEMORY

If unable to allocate memory for the value iterator object.

AM_INVALID_ARGUMENT

If the value_iter_ptr argument is NULL.

AM_NOT_FOUND

If the specified iterator is NULL or does not reference a valid entry.

Details

This function returns an am_map_value_iter_t that enumerates over the values associated with am_map_entry_iter_t.

Memory Concerns After the use of value_iter_t the caller must call am_map_value_iter_destroy.