am_map_create()

Creates a new, empty map object.

Details

am_map_create() creates an instance of a am_map_t and returns a pointer back to the caller.

Syntax

#include "am_map.h"
AM_EXPORT am_status_t
am_map_create(am_map_t *map_ptr);

Parameters

This function takes the following parameter:

map_ptr

Pointer specifying the location of the new map object.

---

Caution –

Be sure not to pass map_ptr as a valid am_map structure as the reference will be lost.

---

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 map object was successfully created.

AM_NO_MEMORY

If unable to allocate memory for the new map object.

AM_INVALID_ARGUMENT

If the map_ptr argument is NULL.