Remark

The Remark command allows you to cause a piece of text to be output to the console and to any linked GUI as well as included in the report generated when running a script. For example, you may use it to create a series of entries describing the current process being undertaking by the Pipeline Runner where it is running an external command line tool that has no output of its own or just where you want to make any watching user aware of the process that is about to be executed..

Command Syntax

Remark:[RemarkText],[BlankLineOption]

The colon after the command is compulsory. The comma after the remark text is only compulsory where a blank line option is specified. The command is not case sensitive, but the remark text will be output verbatim

Parameters:

RemarkText: The text to be output.  

BlankLineOption: Text equivalent to a member of the BlankLineOption enumeration which determines whether the remark has a blank lines.

The RemarkText parameter is compulsory. This can be any text, but must have a value. If the parameter is missing an error will be thrown.

The BlankLine parameter is optional. Valid values are:

•None - no blank lines will be added

•BlankLineAfter - a blank line will be added after the remark text.

•BlankLineBefore - a blank line will be added before the remark text.

•BlankLineBeforeAndAfter - a blank line will be added before and after the remark text.

Creating a Blank Line on its own

If you wish to create a blank line on its own, set the RemarkText parameter value to BLANK-LINE. This is not case sensitive, and will be converted automatically into a blank line.

Examples:

Simple remark:

Remark:This is the first Remark

Remark with a blank line before and after:

Remark:This is the next Remark,BlankLineBeforeAndAfter

See Also: Subs