Crestron SIMPL+ - STRING_OUTPUT Declaration

Crestron SIMPL+
®
Software
Language Reference Guide - DOC. 5797G SIMPL+
®
z 65
STRING_OUTPUT
Name:
STRING_OUTPUT
Syntax:
STRING_OUTPUT <var1>[,<var2>...];
STRING_OUTPUT <var[size]>;
STRING_OUTPUT <var[size[,<min>]][size]>;
Description:
Routes serial strings from the SIMPL+ program to the SIMPL program. A string
length is not required as the output string buffer management is performed by the
operating system. Refer to the discussion on arrays on page 46.
The value of a STRING_OUTPUT cannot be read. If knowledge of the value of the
STRING_OUTPUT is required, the value to be written to the STRING_OUTPUT
can also be written to a STRING for local storage.
In X-Generation Control Systems, if several values are issued to a
STRING_OUTPUT, the logic will only see the last value written to the
STRING_OUTPUT when the SIMPL+ program task switches away. If all values are
required to be seen by the logic, a PROCESSLOGIC statement is required after
writing to the STRING_OUTPUT.
In the 2-Series Control Systems, all values written to a STRING_OUTPUT are
maintained. The logic will see each value of the STRING_OUTPUT. No
PROCESSLOGIC is required.
For an array of STRING_OUTPUTs, the maximum value of SIZE is 65535. Valid
indices are 1 through the specified size.
NOTE: These outputs may be jammed with other serial string signals in the SIMPL
program, although the value does not propagate back into the SIMPL+ symbol.
NOTE: The maximum string length for a STRING_OUTPUT is 255 characters.
Assigning a string with a length of more than 255 will result in a loss of data.
NOTE: You should use isSignalDefined to test whether the output is connected to an
actual signal in the SIMPL Windows program before assigning a value to it. If you
assign a value and there is no signal, a message is placed in the system error log.
NOTE: <min> is the number of outputs shown at a minimum in SIMPL Windows.
The Default is 1. The user can expand the minimum up to the full size. Only the last
array of a type can have <min>. Refer to Arrays on page 31, and Declarations on
page 45.