Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter TwelveInternet Functions (continued)

SerialTxWithDelay Function

Overview

The SerialTxWithDelay function transmits a string with delay characters and an optional escaped control characters.

Syntax/Parameters

Syntax

int = SerialTxWithDelay ( handle hSerial, string data, [int delay] );

Parameters

hSerial

A handle to a Serial Port Object.

data

A string of characters to transmit.

delay

An optional int specifying the delay amount, in milliseconds, to wait when a tilde character is encountered. The default value is 100ms.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure. Use the GetLastError to retrieve a formatted error code.

Remarks

The SerialTxWithDelay is meant principally to communicate with modems. The string can contain specific characters to cause transmission to be briefly paused. The tilde character (~) will cause the transmission to pause for a specified number of milliseconds, the tilde is not transmitted. Multiple tilde characters can be employed or stacked together.

In addition, the hat (^) character can be used to introduce control characters. While this can be performed by simply escaping characters in a string literal with backslashes, this allows strings to be defined within settings that are human readable. For example, “\004” would be represented by “^d” or “^D”.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic