am_log_record_create()

Instantiates a log record, initializing it with a message and the message's corresponding level.

Syntax

#include "am_log.h"
 AM_EXPORT am_status_t 
am_log_record_create(am_log_record_t *record_ptr, 
                     am_log_record_log_level_t log_level,
                     const char *message);

Parameters

This function takes the following parameters:

record_ptr

Pointer to a log record pointer.

log_level

The level with which the log record will be instantiated. Each log record has an associated level that defines its relative importance and urgency. Possible values are defined in the am_log_record_log_level_t enumeration.

typedef enum am_log_record_log_level {

    /* Log Level as defined by JDK 1.4 */

    AM_LOG_LEVEL_SEVERE = 1000,
    AM_LOG_LEVEL_WARNING = 900,
    AM_LOG_LEVEL_INFORMATION = 800,
    AM_LOG_LEVEL_CONFIG = 700,
    AM_LOG_LEVEL_FINE = 500,
    AM_LOG_LEVEL_FINER = 400,
    AM_LOG_LEVEL_FINEST = 300,

    /* Log Levels defined by Access Manager */

    AM_LOG_LEVEL_SECURITY = 950,
    AM_LOG_LEVEL_CATASTROPHE = 850,
    AM_LOG_LEVEL_MISCONF = 750,
    AM_LOG_LEVEL_FAILURE = 650,
    AM_LOG_LEVEL_WARN = 550,
    AM_LOG_LEVEL_INFO = 450,
    AM_LOG_LEVEL_DEBUG = 350,
    AM_LOG_LEVEL_ALL = 250

} am_log_record_log_level_t;

message

Pointer to the log message to be written to the log record.

Returns

This function returns one of the values of the am_status_t enumeration (defined in the <am_types.h> header file).