sInEntryQueue (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Using an external library: RXTX

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.
This function returns information regarding the server.
Versions 16 and later
Infrared ports are not managed.
New in version 16
Infrared ports are not managed.
Infrared ports are not managed.
Versions 25 and later
Only serial ports are managed.
New in version 25
Only serial ports are managed.
Only serial ports are managed.

Versions 16 and later

This function is now available for the Java applications.

New in version 16

This function is now available for the Java applications.

Versions 25 and later

This function is now available for WEBDEV sites in Linux.

This function is now available for WINDEV applications in Linux.

New in version 25

This function is now available for WEBDEV sites in Linux.

This function is now available for WINDEV applications in Linux.

This function is now available for WEBDEV sites in Linux.

This function is now available for WINDEV applications in Linux.

Example

// The port is opened. Retrieves the number of pending bytes
// in the input buffer of COM4 and read them.
PortNum is int
PortNum = sOpen("COM4", 2000, 2000)
Number is int
MessageRead is string
Number = sInEntryQueue(PortNum)
MessageRead = sRead(PortNum, Number)
// Equivalent to: MessageRead = sRead(PortNum, sInEntryQueue(PortNum))

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.
Reminder: In UNICODE, each character occupies two memory bytes.

<Port number>: Integer

Port number to use:
Number of serial port: 1, 2, 3, ... 32 for COM1, COM2, COM3, ... COM32.
Number of infrared port: 1, 2, 3, ... 32 for IR1, IR2, IR3, ... IR32.
Versions 16 and later
The management of infrared ports is not available in Java.
New in version 16
The management of infrared ports is not available in Java.
The management of infrared ports is not available in Java.
Port number returned by sOpen (if this function was called with a port name).

Remarks

Versions 16 and later

Using an external library: RXTX

In Java, the use of functions for handling the serial and parallel ports (sOpen, sWrite, sRead, ...) requires the presence of an external library: RXTX.

This library includes a Jar archive and one or more native libraries that depend on the operating system on which the application is run. To use these functions:

the Jar archive (RXTXComm.jar) must:
- be found in the same directory as the Java application generated by WINDEV,
- be found in the execution classpath of the application,
- be directly included in the generated application (from the wizard for Java generation).
the native libraries corresponding to the operating system on which the application is run must be found:
- in the same directory as the Java application generated by WINDEV,
- in the path of the application libraries (librarypath).

The RXTX library and its documentation can be downloaded from: http://users.frii.com/jarvi/rxtx/index.html (link valid at the time this documentation was published).

Caution: The management of infrared ports is not available in Java.

New in version 16

Using an external library: RXTX

In Java, the use of functions for handling the serial and parallel ports (sOpen, sWrite, sRead, ...) requires the presence of an external library: RXTX.

This library includes a Jar archive and one or more native libraries that depend on the operating system on which the application is run. To use these functions:

the Jar archive (RXTXComm.jar) must:
- be found in the same directory as the Java application generated by WINDEV,
- be found in the execution classpath of the application,
- be directly included in the generated application (from the wizard for Java generation).
the native libraries corresponding to the operating system on which the application is run must be found:
- in the same directory as the Java application generated by WINDEV,
- in the path of the application libraries (librarypath).

The RXTX library and its documentation can be downloaded from: http://users.frii.com/jarvi/rxtx/index.html (link valid at the time this documentation was published).

Caution: The management of infrared ports is not available in Java.

Using an external library: RXTX

In Java, the use of functions for handling the serial and parallel ports (sOpen, sWrite, sRead, ...) requires the presence of an external library: RXTX.

This library includes a Jar archive and one or more native libraries that depend on the operating system on which the application is run. To use these functions:

the Jar archive (RXTXComm.jar) must:
- be found in the same directory as the Java application generated by WINDEV,
- be found in the execution classpath of the application,
- be directly included in the generated application (from the wizard for Java generation).
the native libraries corresponding to the operating system on which the application is run must be found:
- in the same directory as the Java application generated by WINDEV,
- in the path of the application libraries (librarypath).

The RXTX library and its documentation can be downloaded from: http://users.frii.com/jarvi/rxtx/index.html (link valid at the time this documentation was published).

Caution: The management of infrared ports is not available in Java.

Business / UI classification : Business Logic

Component : wd250com.dll