String_Input - Crestron SIMPL+ Reference Manual

Software
®
64 SIMPL+

STRING_INPUT

Name:
STRING_INPUT
Syntax:
STRING_INPUT <var1[max_size1]>[,<var2[max_size2]>...];
STRING_INPUT <var[size][max_size]>;
STRING_INPUT <var[size[,<min>]][max_size]>;
Description:
Routes serial inputs from the outside SIMPL program into a SIMPL+ program under
the specified variable names. Strings are of arbitrary length, so a maximum size must
be specified. Upon receiving new data, the value is cleared and the new string is put
in. Strings received greater than the specified size are truncated to the size in the
declaration. String inputs may be written to, so their data space may be used as a
storage spot for doing something such as parsing through a string without declaring
temporary storage. Refer to the discussion on arrays on
NOTE: STRING_INPUT variables may not be passed to functions in Version 3.00
for the 2-Series Control Systems. If you need to pass a STRING_INPUT variable to
a function, assign it to a locally declared variable and pass that variable to the function.
NOTE: <min> is the number of inputs 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
The value of SIZE and NUM_CHARACTER may be up to 255 in SIMPL+ Version
1.00. In SIMPL+ Version 2.00 and later, they may be up to 65535. For an array of
STRING_INPUTs, the maximum value of SIZE is 65535.
Example:
STRING_INPUT FirstName[100], SecondName[25];
Signifies that two serial inputs are coming into the SIMPL+ program from the SIMPL
Program. The first one may only be a maximum of 100 characters, the second may
only be a maximum of 25 characters. If an input is longer than the specified length,
everything after the specified limit is lost.
STRING_INPUT DataBaseNames[9][100];
Signifies that 9 serial inputs are coming into the SIMPL+ program from the SIMPL
program. Each name has a 100 character limit. The names are referenced as
DataBaseNames[1] through DataBaseNames[9].
STRING_INPUT Database Names [9,3][100];
Same as above except at least three are shown at all times.
Version:
SIMPL+ Version 3.01 for fixed arrays and minimum sizes.
SIMPL+ Version 2.00 for STRING_INPUT arrays and SIZE, NUM_CHARACTER
to 65535.
SIMPL+ Version 1.00 for everything else.
Crestron SIMPL+
page 46.
page 31, and Declarations on
Language Reference Guide - DOC. 5797G
®
page 45