am_map_destroy()

Destroys the map object referenced by the provided handle.

Syntax

#include "am_map.h"
AM_EXPORT void
 am_map_destroy(am_map_t map);

Parameters

This function takes the following parameters:

map

The handle for the map object to be destroyed. The handle may be NULL.

Returns

This function returns one of the following values:

AM_SUCCESS

If the destroy operation was successfully performed.

AM_NO_MEMORY

If there was an internal memory operation error.

AM_INVALID_ARGUMENT

If the address of map_ptr or source_map is invalid.

Details

This function destroys an instance of am_map_t structure which is pointed by map_ptr.

Memory Concerns: Care must be taken that map_ptr was not freed before by calling am_map_destroy or by erroneously calling the system void free (void *) function.