Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter TwelveInternet Functions (continued)

SerialTxPurge Function

Overview

The SerialTxPurge function clears any pending transmit information and stops transmitting.

Syntax/Parameters

Syntax

int = SerialTxPurge ( handle hSerial );

Parameters

hSerial

A handle to a Serial Port Object.

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

This function allows a transmit operation to be stopped. If the transmit is pending a handshake, it will still be terminated. Depending on the device and the channel, it is possible that characters will continue to transmit.

Related Functions

Platform Support

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

Legato IDE, Legato Basic