Logging

The following functions are provided for logging and end user notification.

LogMessageT()

Log a message that has occurred in the module, at a certain level. For example, Info, Warning, Error.

This usually logs to the log file and the stdout of the process.

PreJob:

LogMessageT(PreJobInfoT *JobInfo, LogMessageLevelE level, const char *Message) 

PrepareJob, PerformJob or CleanUpJob:

LogMessageT(JobInfoT *JobInfo, LogMessageLevelE level, const char *Message)

IsLoggingEnabledForT()

Check if logging is enabled at the specified logging level.

You can use this to conditionally avoid doing expensive debug operations or to log to a separate location (use LogMessageT for normal cases).

PreJob:

IsLoggingEnabledForT(PreJobInfoT *JobInfo, LogMessageLevelE level) 

PrepareJob, PerformJob or CleanUpJob:

IsLoggingEnabledForT(JobInfoT *JobInfo, LogMessageLevelE level)

GetLogOutputLocationT()

Get the output location for logging.

This can be useful if you want to write other output to a separate file (use LogMessageT for normal cases).

PreJob:

GetLogOutputLocationT(PreJobInfoT *JobInfo) 

PrepareJob, PerformJob or CleanUpJob:

GetLogOutputLocationT(JobInfoT *JobInfo)

SendUserMessageT()

Send a message to the user whose job is being processed by this module.

These messages can be displayed in the SuperSTAR client applications.

PreJob:

SendUserMessageT(PreJobInfoT *JobInfo, UserMessageLevelE level, const char *Message) 

PrepareJob, PerformJob or CleanUpJob:

SendUserMessageT(JobInfoT *JobInfo, UserMessageLevelE level, const char *Message)

SendUserUnicodeMessageT()

Send a message to the user whose job is being processed by this module.

These messages can be displayed in the SuperSTAR client applications.

SendUserUnicodeMessageT(JobInfoT *JobInfo, UserMessageLevelE level, const wchar_t *Message)