am_map_entry_iter_get_key()

Returns the key of the element currently referenced by the specified iterator.

Syntax

#include "am_map.h"
AM_EXPORT const char *
am_map_entry_iter_get_key(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.

Returns

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

NULL

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

key

Otherwise

Details

This function returns the key of this key-value pair entry iterator.

Memory Concerns: Caller must not modify or free the return value.