XenoGuard Documentation

Write Text

Actions » Programming » General » Write Text 

The action Write Text displays a string value and stores it in the Text of the result list. In addition, the error status of the output can be changed. The error status Error sets the execution status to Failed. The action is marked with a red execution icon accordingly. In the XenoGuard Plus version and the Premium version, the text is additionally written to the log file if logging is enabled.



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

Parameters:

The action has the following input parameters:


name Description
Text Specifies the string value to be displayed.

Allowed Context Scopes
[Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]
Protocol State
Sets the error status of the output. You can choose between Not Set, Passed and Failed.

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 (Display text with the protocol state Passed):

This example outputs the result of the multiplication and a text coming from variable Notice with Write Text.

See other general actions:

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