Represents a logmessage being prepared for output in a (output) logchannel.

For a list of all members of this type, see ITLogMsg members.

Syntax

[Visual Basic]
Public Class ITLogMsg

[C#]
public class ITLogMsg

[JScript]
public class ITLogMsg

Remarks

Lifecycle of ITLogMsg objects

From creation on an ITLogMsg object is connected to its (output) logchannel (class ITOutputLogChannel); if you don’t give one, the default channel "StdLog" is used.

The typical life cycle of an ITLogMsg object looks as follows:

create logmessage
modify logmessage properties
The most important property is the property Text containing the actual logmessage text, and the most common operation is to append text to this property.
send logmessage to the logchannel -- or cancel it to prevent output

The logmessage is sent to the logchannel

when you call ITLogMsg.Send

or, if you forgot that,

as soon as there doesn’t exist an ITLogMsg instance any more that refers to it.
Under .NET you have to wait until garbage collection finds that out and finalizes the last ITLogMsg instance.

Creating ITLogMsg objects

There are two ways to create an ITLogMsg object:

using ITLogMsg.Create methods
using ITOutputLogChannel.CreateLogMsg

To create the object, besides the logchannel name you give the name of the Module and the name of the Case under which to message is to be logged. These names are displayed in the ITLogBook application and can be used there to define display filters. Module and Case have not defaults.

Module and Case are also be used as the basis for the write-out filter mechanism. This mechanism allows you to suppress the output of certain logmessages. Write-out filters are defined on a per-log-channel basis. They are stored in the configuration file and can be modified at run-time.

Besides the logchannel, the Module and the Case at ITLogMsg creation time you can also set the initial Loglevel. The meaning of the loglevel is explained in ITLogLevel enum and its connection to the LogLevel of a log message.

The logmessage also automatically gets a time-stamp, which can be queried using ITLogMsg.TimeAsString.

To summarize, the properties of the logmessage set at creating time are (in the order as displayed in the ITLogBook application):

logchannel
loglevel
time stamp
Module and Case name
logmessage text: set to "".

Modifying ITLogMsg objects

The properties that can still be modified after the creation of the logmessage object are

the loglevel
Use the read/write property ITLogMsg.LogLevel to get and set the LogLevel.
Additionally, there is a method ITLogMsg.AddLogLevel to modify the LogLevel.
For more information see: ITLogLevel enum.

and

the logmessage text.
Use ITLogMsg.Add to add text to it and ITLogMsg.Text to get the current text.

Sending or canceling ITLogMsg objects

This is done by calling ITLogMsg.Send or ITLogMsg.Cancel. The logmessage is also sent when the last ITLogMsg object that refers to it gives up its reference.

See Also

Language

ITLogMsg Class