Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter TwelveInternet Functions (continued)

SerialRxPurge Function

Overview

The SerialRxPurge function empties the receive queue and discards the contents.

Syntax/Parameters

Syntax

int = SerialRxPurge ( 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

The purge function clears both the internal serial receive buffer as well as any partial buffer information from unfulfilled read operations.

Related Functions

Platform Support

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

Legato IDE, Legato Basic