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


Produces a logging message from the specified event string.


When using am_log_log(), consider the following:


#include "am_log.h"
AM_EXPORT boolean_t
am_log_log(am_log_module_id_t moduleID,
           am_log_level_t level,
           const char *format, ...);


This function takes the following parameters:


The identifier of the OpenSSO Enterprise logging module to which the message is relevant.


The level of the message. Each message has an associated level that defines the amount of detail that will be logged. Possible values are defined in the am_log_level_t enumeration. The default value is AM_LOG_INFO.

typedef enum am_log_level {
    AM_LOG_ALWAYS = -1, /* always logged */
    AM_LOG_NONE,	/* never logged, typically used to turn off a module */
    AM_LOG_ERROR,	/* used for error messages */
    AM_LOG_WARNING,	/* used for warning messages */
    AM_LOG_INFO,	/* used for informational messages */
    AM_LOG_DEBUG,	/* used for debug messages */
    AM_LOG_MAX_DEBUG,    /* used for more detailed debug messages */
    AM_LOG_AUTH_REMOTE = 128, /* logged deny and/or allow */
} am_log_level_t;

Pointer to a printf-style character string detailing the event.

Note –

The set of additional arguments needed by format are either enumerated directly or passed using the standard va_list mechanism as appropriate to the call. See am_log_vlog().


This function returns one of the values of the boolean_t enumeration (defined in the standard <types.h> header file):

Note –

The code used is dependent on the server operating system.


If the message is logged.


If the message will not be logged.