This is the documentation for SuperSTAR 9.8

SuperSTAR 9.9 is now available.
View this page in the SuperSTAR 9.9 documentation or visit the SuperSTAR 9.9 documentation home.

Skip to end of metadata
Go to start of metadata

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.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

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

PrepareJob, PerformJob or CleanUpJob:

LogMessageT(JobInfoT *JobInfo, LogMessageLevelE level, const char *Message)
Arguments
JobInfoInformation about the current job.
levelThe information level:
  • LOG_LEVEL_ERROR
  • LOG_LEVEL_WARN

  • LOG_LEVEL_INFO

  • LOG_LEVEL_DEBUG

  • LOG_LEVEL_TRACE

MessageThe message to log.

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

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

IsLoggingEnabledForT(PreJobInfoT *JobInfo, LogMessageLevelE level) 

PrepareJob, PerformJob or CleanUpJob:

IsLoggingEnabledForT(JobInfoT *JobInfo, LogMessageLevelE level)
Arguments
levelThe logging level:
  • LOG_LEVEL_ERROR
  • LOG_LEVEL_WARN
  • LOG_LEVEL_INFO
  • LOG_LEVEL_DEBUG
  • LOG_LEVEL_TRACE
Returns
1Logging at the specified level is enabled.
0Logging is not enabled at this 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).

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

GetLogOutputLocationT(PreJobInfoT *JobInfo) 

PrepareJob, PerformJob or CleanUpJob:

GetLogOutputLocationT(JobInfoT *JobInfo)
Arguments
JobInfoInputInformation about the current job.
Returns
const char*

The location of the path.

NULLIf there is no location.

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.

Available To
PreJob
PrepareJob
PerformJob
CleanUpJob

PreJob:

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

PrepareJob, PerformJob or CleanUpJob:

SendUserMessageT(JobInfoT *JobInfo, UserMessageLevelE level, const char *Message)
Arguments
JobInfoInformation about the current job.
levelThe information level:
  • LEVEL_ERROR

  • LEVEL_WARN

  • LEVEL_INFO

MessageThe user message.
Returns
1Success.
0Failed.

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.

Available To
PrepareJob
PerformJob
CleanUpJob
SendUserUnicodeMessageT(JobInfoT *JobInfo, UserMessageLevelE level, const wchar_t *Message)
Arguments
JobInfoInformation about the current job.
levelThe information level:
  • LEVEL_ERROR

  • LEVEL_WARN

  • LEVEL_INFO

MessageThe user message.
Returns
1Success.
0Failed.
  • No labels