am_map_entry_iter_get_first_value()

Returns the first value of the element currently referenced by the specified iterator.

Syntax

#include "am_map.h"
AM_EXPORT const char *
am_map_entry_iter_get_first_value(am_map_entry_iter_t entry_iter);

Parameters

This function takes the following parameter:

entry_iter

The handle for the entry iterator object to be examined.

Returns

This function returns const char * with one of the following values:

Value

If the operation is successful, returns the first associated value of this iterator. The order of insertion into the map does not guarantee the value returned.

NULL

If the specified iterator is NULL or does not reference a valid entry or the entry does not have any associated values.

Details

This function destroys the am_map_entry_iterator_t passed to it.

Memory Concerns: Caller must be sure that this function is not called multiple times on the same am_map_entry_iter_t.