Generated from ./inc/complib/cl_log.h with ROBODoc v4.99.17 on Sun Mar 04 2007 18:17:52

[Modules] Component Library/Log Provider

[top][parent][index]

NAME

       Log Provider

DESCRIPTION

       The log provider allows users to log information in a system log instead of
       the console or debugger target.

[Functions] Component Library: Log Provider/cl_log_event

[top][index]

NAME

       cl_log_event

DESCRIPTION

       The cl_log_event function adds a new entry to the system log.

SYNOPSIS

CL_EXPORT void CL_API
cl_log_event(
        IN      const char* const       name,
        IN      const cl_log_type_t     type,
        IN      const char* const       message,
        IN      const void* const       p_data OPTIONAL,
        IN      const uint32_t          data_len );

PARAMETERS

       name
               [in] Pointer to an ANSI string containing the name of the source for
               the log entry.

       type
               [in] Defines the type of log entry to add to the system log.
               See the definition of cl_log_type_t for acceptable values.

       message
               [in] Pointer to an ANSI string containing the text for the log entry.
               The message should not be terminated with a new line, as the log
               provider appends a new line to all log entries.

       p_data
               [in] Optional pointer to data providing context for the log entry.
               At most 256 bytes of data can be successfully logged.

       data_len
               [in] Length of the buffer pointed to by the p_data parameter.  Ignored
               if p_data is NULL.

RETURN VALUE

       This function does not return a value.

NOTES

       If the data length exceeds the maximum supported, the event is logged
       without its accompanying data.

SEE ALSO

       Log Provider, cl_log_type_t

[Definitions] Component Library: Log Provider/cl_log_type_t

[top][index]

NAME

       cl_log_type_t

DESCRIPTION

       The cl_log_type_t enumerated type is used to differentiate between
       different types of log entries.

SYNOPSIS

typedef enum _cl_log_type
{
        CL_LOG_INFO,
        CL_LOG_WARN,
        CL_LOG_ERROR

} cl_log_type_t;

VALUES

       CL_LOG_INFO
               Indicates a log entry is purely informational.

       CL_LOG_WARN
               Indicates a log entry is a warning but non-fatal.

       CL_LOG_ERROR
               Indicates a log entry is a fatal error.

SEE ALSO

       Log Provider, cl_log_event