am_map_clear()

Erases all of the entries in the specified map object.

Syntax

#include "am_map.h"
AM_EXPORT am_status_t
am_map_clear(am_map_t map);

Parameters

This function takes the following parameter:

map

The map object.

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 the entries were successfully erased.

AM_INVALID_ARGUMENT

If the map argument is NULL.