LogMessage Method (ScriptHostInterface)

In This Topic

Logs a message to the Job Log for the job.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Shared Sub LogMessage( _
   ByVal messageType As MessageTypeEnum, _
   ByVal messageCode As Integer, _
   ByVal message As String _
)

public static void LogMessage( 
   MessageTypeEnum messageType,
   int messageCode,
   string message
)

public:
static void LogMessage( 
   MessageTypeEnum messageType,
   int messageCode,
   String^ message
)

Parameters

messageType: The message type (severity)
messageCode: The message code. Can be used to filter messages. Note: The value 100000 will be added to the messageCode when the message is recorded in adTempus.
message: The message text.

Remarks

Each message logged with LogMessage creates a log message in the Job Log for the job and a record in the adTempus database. To avoid cluttering the job log and using large amounts of database space, use MessageTypeEnum.Debug for debug-level messages. These messages will be written to the Job Detail Log instead of the main Job Log. The detail log is a single log file with detailed/diagnostic information for the job, available from the Captured Files list for the job.

Reference

ScriptHostInterface Class
ScriptHostInterface Members