Sun OpenSSO Enterprise 8.0 C API Reference for Application and Web Policy Agent Developers

am_map_erase()

Erases the entry, associated with the specified key, from the specified map object.

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 specified map object.

key

Pointer to the key of the entry to be erased.

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 entry was successfully erased.

AM_INVALID_ARGUMENT

If either the map or key argument is NULL.

AM_NOT_FOUND

If the specified key is not in the map.