STK X	Send comments on this topic.
OnLogMessage Event (AgSTKXApplication)
See Also

Message: Text of the message.

MsgType: Type of the message.

ErrorCode: Error code associated with the message (for AGI trouble shooting).

FileName: File name associated with the message (for AGI trouble shooting).

LineNo: Line number associated with the message (for AGI trouble shooting).

DispID: Display destination.

Description

Triggered when a new message is logged.

Syntax

[Visual Basic .NET]
Public Event OnLogMessage( _ ByVal Message As String, _ ByVal MsgType As AgELogMsgType, _ ByVal ErrorCode As Integer, _ ByVal FileName As String, _ ByVal LineNo As Integer, _ ByVal DispID As AgELogMsgDispID _ )

[Visual Basic .NET]

Public Event OnLogMessage( _
   ByVal Message As String, _
   ByVal MsgType As AgELogMsgType, _
   ByVal ErrorCode As Integer, _
   ByVal FileName As String, _
   ByVal LineNo As Integer, _
   ByVal DispID As AgELogMsgDispID _
)

[C#]
public void OnLogMessage( string Message, AgELogMsgType MsgType, int ErrorCode, string FileName, int LineNo, AgELogMsgDispID DispID );

[C#]

public void OnLogMessage(

   string Message, 

   AgELogMsgType MsgType, 

   int ErrorCode, 

   string FileName, 

   int LineNo, 

   AgELogMsgDispID DispID

);

[Managed C++]
public: void OnLogMessage( String __gc ^ Message, AgELogMsgType MsgType, int ErrorCode, String __gc ^ FileName, int LineNo, AgELogMsgDispID DispID );

[Managed C++]

public: void OnLogMessage(

   String __gc ^ Message, 

   AgELogMsgType MsgType, 

   int ErrorCode, 

   String __gc ^ FileName, 

   int LineNo, 

   AgELogMsgDispID DispID

);

[Java]
public onLogMessage( String Message, AgELogMsgType MsgType, int ErrorCode, String FileName, int LineNo, AgELogMsgDispID DispID );

[Java]

public  onLogMessage(

   String Message, 

   AgELogMsgType MsgType, 

   int ErrorCode, 

   String FileName, 

   int LineNo, 

   AgELogMsgDispID DispID

);

[Unmanaged C++]
public: HRESULT OnLogMessage( BSTR Message, AgELogMsgType MsgType, long ErrorCode, BSTR FileName, long LineNo, AgELogMsgDispID DispID );

[Unmanaged C++]

public: HRESULT OnLogMessage(

   BSTR Message, 

   AgELogMsgType MsgType, 

   long ErrorCode, 

   BSTR FileName, 

   long LineNo, 

   AgELogMsgDispID DispID

);

Parameters

Message

Text of the message.

MsgType

Member	Value	Description
eLogMsgDebug	0	Debugging message.
eLogMsgInfo	1	Informational message.
eLogMsgForceInfo	2	Informational message.
eLogMsgWarning	3	Warning message.
eLogMsgAlarm	4	Alarm message.

Type of the message.

ErrorCode

Error code associated with the message (for AGI trouble shooting).

FileName

File name associated with the message (for AGI trouble shooting).

LineNo

Line number associated with the message (for AGI trouble shooting).

DispID

Member	Value	Description
eLogMsgDispAll	-1	STK displays the message in all the log destination.
eLogMsgDispDefault	0	STK displays the message in the default log destination.
eLogMsgDispMsgWin	1	STK displays the message in the message window.
eLogMsgDispStatusBar	2	STK displays the message in the status bar.

Display destination.

Remarks

You can implement your own logging capabilities using this event. Messages that would normally display in the STK Message Viewer will be sent out using this event.

Description

Syntax

Parameters

Remarks

See Also