Sun Java System Access Manager 7.1 C API Reference

am_log_vlog()

Logs a message for the specified module at the given level.

Details

When using am_log_vlog(), consider the following:

Syntax

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

Parameters

This function takes the following parameters:

moduleID

The identifier of the Access Manager 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.


Note –

The set of addition arguments needed by format are either enumerated directly or passed using the standard va_list mechanism as appropriate to the call.


va_list

A void pointer interpreted as an argument list. va_list is the type of the void pointer passed to a function that accepts a pointer to a list of arguments.


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


Returns

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. See <am_types.h> for more details.


!0

If the message can be logged.

0

If the message will not be logged.