XenoGuard Documentation

Write System Message

Actions » Programming » General » Write System Message 

The action Write System Message displays a string value in the output dock panel and stores them in the log file. In addition, the system message displays an orange state color for warning messages and a red state color for error messages in the output dock panel.



[-] Hide
  1. Open the Programming node in the Workspace Explorer.
  2. In the General node, select the Write System Message action.

Parameters:

The action has the following input parameters:


name Description
Text The text to be written.

Allowed Context Scopes
[Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]
Message Type 
The type of message to be written.

Accepted Values: Information, Warning, Error

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]

Results:

The action returns the following results:


name
description
Text Contains the written text.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter]

Example 1 (Store Ping test result in a log file):

This example creates a local variable named IP Address with Text as data type.  A ping test is then conducted on the value of the variable. If the action Ping runs successfully, the result of the ping test and the current date is displayed in the output dock panel and saved in a system log file.

See other general actions:

Region of Actions
Write Text
Comment
Comment Line
Show Message Box
Show Workspace Information
Show Execution Information