am_log_add_module()

Adds a new module to the list of known logging modules.

Syntax

#include "am_log.h"
AM_EXPORT am_status_t
am_log_add_module(const char *name, am_log_module_id_t *id_ptr);

Parameters

This function takes the following parameters:

name

The name to associate with the new module.

id_ptr

Where to store the id of the logging module.

Returns

This function returns am_status_t with one of the following values:

AM_SUCCESS

If no error is detected.

AM_INVALID_ARGUMENT

If name or id_ptr is NULL.

AM_NSPR_ERROR

If unable to initialize to the logging package.

AM_NO_MEMORY

If unable to allocate memory for the new logging module.

AM_FAILURE

If any other error is detected.

Details

If a module of the same name already exists, then the module ID of that module is returned.