Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter TwelveInternet Functions (continued)

SerialTxString Function

Overview

The SerialTxString function transmits a string.

Syntax/Parameters

Syntax

int = SerialTxString ( handle hSerial, string data );

Parameters

hSerial

A handle to a Serial Port Object.

data

A string of characters to transmit.

Return Value

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

Remarks

SerialTxString can immediately return prior to sending all the data depending on the size of the data to be transmitted and the amount of available transmit queue space.

The Data Carrier Detect (DCD) testing is enabled, the transmit function continuously monitors the link status. If the status becomes “off-line” the function will return with an error. Handshaking is performed according to the handshake settings.

SerialTxString by default sends all characters in a string until a zero byte is encounter (0x00) to mark the end of the string. Therefore, SerialTxString cannot send pure binary information. To send binary data, use the SerialTxBlock function.

Related Functions

Platform Support

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

Legato IDE, Legato Basic