Module log Methods

CloseWizardLog() closes the Wizard log.

The format of the CloseWizardLog method is:

  CloseWizardLog(void)

GetLogInfoList() returns any logs that match the specified pattern.

The format of the GetLogInfoList function is:

  const LogInfo **GetLogInfoList(const char *pattern,
    size_t *number_preferences,ExceptionInfo *exception)

A description of each parameter follows:

pattern

Specifies a pointer to a text string containing a pattern.

number_preferences

This integer returns the number of logs in the list.

exception

Return any errors or warnings in this structure.

GetLogList() returns any logs that match the specified pattern.

The format of the GetLogList function is:

  char **GetLogList(const char *pattern,size_t *number_preferences,
    ExceptionInfo *exception)

A description of each parameter follows:

pattern

Specifies a pointer to a text string containing a pattern.

number_preferences

This integer returns the number of logs in the list.

exception

Return any errors or warnings in this structure.

GetLogName() returns the current log name.

The format of the GetLogName method is:

  const char *GetLogName(void)

IsEventLogging() returns WizardTrue if debug of events is enabled otherwise WizardFalse.

The format of the IsEventLogging method is:

  WizardBooleanType IsEventLogging(void)

ListLogInfo() lists the log info to a file.

The format of the ListLogInfo method is:

  WizardBooleanType ListLogInfo(FILE *file,ExceptionInfo *exception)

A description of each parameter follows.

file

An pointer to a FILE.

exception

Return any errors or warnings in this structure.

LogWizardEvent() logs an event as determined by the log configuration file. If an error occurs, WizardFalse is returned otherwise WizardTrue.

The format of the LogWizardEvent method is:

  WizardBooleanType LogWizardEvent(const LogEventType type,
    const char *module,const char *function,const size_t line,
    const char *format,...)

A description of each parameter follows:

type

The event type.

filename

The source module filename.

function

The function name.

line

The line number of the source module.

format

The output format.

LoadLogLists() loads one or more log configuration file which provides a mapping between log attributes and log name.

The format of the LoadLogLists method is:

  WizardBooleanType LoadLogLists(const char *filename,
    ExceptionInfo *exception)

A description of each parameter follows:

filename

The log configuration filename.

exception

Return any errors or warnings in this structure.

SetLogEventMask() accepts a list that determines which events to log. All other events are ignored. By default, no debug is enabled. This method returns the previous log event mask.

The format of the SetLogEventMask method is:

  LogEventType SetLogEventMask(const char *events)

A description of each parameter follows:

events

log these events.

SetLogFormat() sets the format for the "human readable" log record.

The format of the LogWizardFormat method is:

  SetLogFormat(const char *format)

A description of each parameter follows:

format

The log record format.

SetLogName() sets the log name and returns it.

The format of the SetLogName method is:

  const char *SetLogName(const char *name)

A description of each parameter follows:

log_name

SetLogName() returns the current client name.

name

Specifies the new client name.