GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Twelve — Internet Functions (continued)

SerialGetRxQueueCount Function

Overview

The SerialGetRxQueueCount function returns the number of unread characters in the receive queue.

Syntax/Parameters

Syntax

int = SerialGetRxQueueCount ( handle hSerial );

Parameters

hSerial

A handle to a Serial Port Object.

Return Value

Returns an int containing the number of available characters or a formatted error code on failure.

Remarks

The Rx queue count does not count any characters loaded by the SerialRxLine, SerialRxBlock or SerialRxString that may be in the buffer but failed because of a time-out.

Related Functions

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

SerialRxCharacter — Checks the input queue for a character.

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.

SerialRxSetTimeout — Sets the time-out value for receiving characters.

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 10/21/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.