am_map_clear()

Erases all of the entries in the specified map.

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 handle for the map object to be modified.

Returns

This function returns am_status_t with one of the following values:

AM_SUCCESS

If no error was detected.

AM_INVALID_ARGUMENT

If the map argument is NULL.