OutputString

Syntax

OutputString(str);

str	A string or variable containing a string of text.

Description

Outputs a line of text directly to the output buffer of a StreamOUT or XMLOUT Process. The script can be placed before and after Processes and inside Processes.

Note:

Only available for StreamOUT and XMLOUT Processes. Any other Process type will ignore the script and a log message will be written.

In StreamOUT, the character separator inside records will be ignored before and after the script string, so if the script is executed between two fields in a record that is not fixed positioned then no separator will be written between the fields. If you want to include the separator, it will have to be included in the script.

Note:

Special characters (such as carriage return, line feed, tabs etc.) can be written to the stream using the hex values for these characters.

Returns

	String was written successfully.
	String was not written successfully.

Example

The script can be used in an XMLOUT Process to output a variable in the XML prologue. Insert the script after the XML Header or the XML document type. For example:

outputstring($fieldvariable);

The $fieldvariable variable is assigned the value of a field which is displayed as text in the XML prologue.