sInEntryQueue (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Standard functions / Windows functions / Serial/Parallel Ports functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

sInEntryQueue (Function)

In french: sDansFileEntrée

Retrieves the number of pending bytes in the input buffer of a specified serial port or infrared port.

Remarks:

This function cannot be used with a parallel port.

Example

// Le port est ouvert. Récupère le nombre d'octets en attente
// dans le buffer d'entrée de COM4 et fait une lecture.
NumPort is int
NumPort = sOpen("COM4", 2000, 2000)
Nombre is int
MessageLu is string
Nombre = sInEntryQueue(NumPort)
MessageLu = sRead(NumPort, Nombre)
// On aurait aussi pu écrire MessageLu = sLit(NumPort, sDansFileEntrée(NumPort))

Syntax

<Result> = sInEntryQueue(<Port number>)

<Result>: Integer

Number of pending bytes in the input buffer of the specified port,
0 if the function failed. The ErrorOccurred variable is set to True if an error occurred on the port (parity bit for example). The error details are returned by ErrorInfo.

<Port number>: Integer

Port number to use:
Serial port number: 1, 2, 3, ... 32 for COM1, COM2, COM3, ... COM32.
Infrared port number: 1, 2, 3, ... 32 for IR1, IR2, IR3, ... IR32.
Port number returned by sOpen (if this function was called with a port name).

Remarks

Business / UI classification: Business Logic

Component: wd300com.dll