am_map_entry_iter_get_values()

Returns a value iterator that can be used to sequence through the values assigned to the entry currently being referenced by the specified entry iterator.

Syntax

#include "am_map.h"
AM_EXPORT am_status_t
am_map_entry_iter_get_values(am_map_entry_iter_t entry_iter,
                             am_map_value_iter_t *value_iter_ptr);

Parameters

This function takes the following parameters:

entry_iter

The specified entry iterator.

value_iter_ptr

Pointer specifying the location of the value iterator.

Returns

This function returns one of the following values of the am_status_t enumeration (defined in the <am_types.h> header file):

AM_SUCCESS

If no error was detected.

AM_NO_MEMORY

If unable to allocate memory for the key iterator.

AM_INVALID_ARGUMENT

If the value_iter_ptr argument is NULL.

---

Note –

If value_iter_ptr is not NULL and an error is returned, the location that it references will be set to NULL.

---

AM_NOT_FOUND

If the entry_iter argument is NULL or does not reference a valid entry.

Memory Concerns

After using am_map_value_iter_t, the caller must call am_map_value_iter_destroy().