csmstr - Omega Engineering

PORTINPUT(PORT, START, END, TIMEOUT, LENGTH)
CRIMSON USER MANUAL - MODULAR CONTROLLER
PORTINPUT(PORT, START, END, TIMEOUT, LENGTH)
ARGUMENT TYPE DESCRIPTION
port int The raw port to be read.
start int The start character to match, if any.
end int The end character to match, if any.
timeout int The inter-character timeout in milliseconds, if any.
length int The maximum number of characters to read, if any.
DESCRIPTION
Reads a string of characters from the port indicated by port, using the various other
parameters to control the input process. If start is non-zero, the process begins by waiting
until the character indicated by this parameter is received. If start is zero, the receive
process begins immediately. The process then continues until one of the following conditions
has been met…
• end is non-zero and a character matching end is received.
• timeout is non-zero, and that period passes without a character being received.
• length is non-zero, and that many characters have been received.
The function then returns the characters received, not including the start or end byte. This
function is used together with Raw Port drivers to implement custom protocols using
Crimson’s programming language. It replaces the RYOP functionality found in Edict.
FUNCTION TYPE
This function is active.
RETURN TYPE
cstring.
EXAMPLE
Frame := PortInput(1, '*', 13, 100, 200)
PAGE 386
http://www.redlion.net/controller