am_map_erase()

Erases the specified key from the specified map.

Syntax

#include "am_map.h"
AM_EXPORT am_status_t
am_map_erase(am_map_t map, const char *key);

Parameters

This function takes the following parameters:

map

The handle for the map object to be modified.

key

The key for the entry to erase.

Returns

This function returns am_status_t with one of the following values:

AM_SUCCESS

If the entry was successfully erased from the map.

AM_INVALID_ARGUMENT

If either the map or key argument is NULL.

AM_NOT_FOUND

If the specified key is not currently in the map.