am_log_log()

Produces a logging message from the specified event string.

Details

When using am_log_log(), consider the following:

• The message is produced only if the level defined for the specified module is greater than or equal to the level defined for the message. See am_log_is_level_enabled().

• am_log_log() directly enumerates arguments for the format string. See am_log_vlog() for another method.

Syntax

#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, ...);

Parameters

This function takes the following parameters:

moduleID

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

level

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_AUTH_LOCAL = 256
} am_log_level_t;

format

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().

---

Returns

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

The code used is dependent on the server operating system.

!0

If the message is logged.

0

If the message will not be logged.