GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Twelve — Internet Functions (continued)

SerialRxCharacter Function

Overview

The SerialRxCharacter function pulls a single character (byte) from the receive queue.

Syntax/Parameters

Syntax

int = SerialRxCharacter ( handle hSerial, [int ms] );

Parameters

hSerial

A handle to a Serial Port Object.

ms

An optional int specifying how long to wait in milliseconds for a character. If no characters become available during the wait period, an ERROR_EOD will be returned. The default value is -1 indicating to wait the default amount of time.

Return Value

Returns an int as a character or a formatted error code on failure. Use the GetLastError to retrieve a formatted error code. On timeout ERROR_EOD is returned.

Remarks

SerialRxCharacter reads a single character from the queue. If a timeout value is specified, the function will wait the specified time for a character. Should a character not arrive in time, an error is returned. The function checks the receive queue and if no data is available checks the timeout and releases (sleeps) the thread and tries again.

Reading single characters from a serial channel is a low-level operation and is not efficient. Further, the receive queue differs from the receive buffer. If a receive operation times out and characters remain in the receive buffer, this function will not retrieve those characters. Caution should be exercised when mixing single character operations with buffer and line operations.

Related Functions

SerialRxBlock — Reads a buffer of characters of a specified size.

SerialRxLine — Receive characters until end of line, escape character or time-out.

SerialRxPeek — Peeks at the input buffer and returns one or more characters.

SerialRxPurge — Purges the input queue and buffer.

SerialRxString — Reads a string of a specified size or with a specific escape sequence.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.