sOpen (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Miscellaneous
Opening and initializing an infrared port by specifying its name (syntax 2)
Using an external library: RXTX

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

sOpen (Function)

In french: sOuvre

Opens and initializes:

a serial port.
a parallel port.
an infrared port. In this last case, the second syntax must be used.

The default values are as follows:

Transfer rate: 9600 Bauds
Parity: None
8 data bits
1 stop bit

Remarks:

If the WIN.INI file contains initialization values for the specified serial port, these values are used.
The following entries of the registry return the list of serial ports and parallel ports:
- "HKEY_LOCAL_MACHINE\HARDWARE\DEVICEMAP\SERIALCOMM" for the serial ports.
- "HKEY_LOCAL_MACHINE\HARDWARE\DEVICEMAP\PARALLEL PORTS" for the parallel ports.
This function affects the server.
Versions 25 and later
Only serial ports can be opened and initialized.
New in version 25
Only serial ports can be opened and initialized.
Only serial ports can be opened and initialized.
Versions 25 and later
By default, users do not have access to serial ports. It is necessary to grant them specific rights to manage serial ports.
New in version 25
By default, users do not have access to serial ports. It is necessary to grant them specific rights to manage serial ports.
By default, users do not have access to serial ports. It is necessary to grant them specific rights to manage serial ports.

Caution: In order for sOpen to operate, "Receive all incoming beams" must be unchecked on the Pocket PC used. To display this option:

Select "Start .. Parameter".
Display the "Connection" tab.
Click the "Send" icon.

Versions 16 and later

This function is now available for Java applications.

New in version 16

This function is now available for 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

See additional examples

// Open COM1 (using the port number)
LineCom1 = sOpen(1, 2000, 2000)
IF LineCom1 = True THEN
// Configure COM1: Rate 9600, even parity,
// 8 data bits, 1 stop bit
sParameter(1, 9600, 1, 8, 0)
// Rest of process...
// Close COM1
sClose(1)
ELSE
Error("Error while opening COM1")
END

// Open IR1 (using the port name)
IR1 = sOpen("IR1", 2000, 2000)
IF IR1 <> 0 THEN
// Configure IR1
sParameter(IR1, 9600, 1, 8, 1)
// Rest of process...
// Close IR1
sClose(IR1)
ELSE
Error("Error while opening IR1")
END

Syntax

Not available in Linux

Opening and initializing a port by specifying its number Hide the details

<Result> = sOpen(<Port number> , <Size of input buffer> , <Size of output buffer> [, <Timeout> [, <Managing events>]])

<Result>: Boolean

True if the port was opened and initialized,
False otherwise.

<Port number>: Integer

Number of relevant port:
Number of serial port: 1, 2, 3, ... 256 for COM1, COM2, COM3, ... COM256.
Number of parallel port: -1, -2, -3 or -4 for LPT1, LPT2, LPT3 or LPT4.

<Size of input buffer>: Integer

Size of input buffer in bytes (up to 32768).

<Size of output buffer>: Integer

Size of output buffer in bytes (up to 32768).

<Timeout>: Optional integer or optional Duration

Duration (expressed in milliseconds) allocated for reading or writing a character.
This parameter is used to avoid a lock when a read or write problem occurs on the print port.
When <Timeout> has expired, the read or write function returns 0.
The default value of this parameter is defined at system level.
The sDefaultTimeout constant allows you to use the default timeout.
This parameter can correspond to:
an integer corresponding to the number of milliseconds,
a Duration variable,
Versions 23 and later
the direct indication of duration (1 s or 10 ms for example).
New in version 23
the direct indication of duration (1 s or 10 ms for example).
the direct indication of duration (1 s or 10 ms for example).
Versions 16 and later
No timeout will be applied if this parameter is not specified. The sDefaultTimeout constant is not available. If a timeout is specified, it will be applied to the read operations performed on the serial ports.
New in version 16
No timeout will be applied if this parameter is not specified. The sDefaultTimeout constant is not available. If a timeout is specified, it will be applied to the read operations performed on the serial ports.
No timeout will be applied if this parameter is not specified. The sDefaultTimeout constant is not available. If a timeout is specified, it will be applied to the read operations performed on the serial ports.

<Managing events>: Optional boolean

True to detect the events on the serial port,
False (default value) to avoid managing the events. These events can be managed by sEvent.

Opening and initializing a port by specifying its name Hide the details

<Result> = sOpen(<Port name> , <Size of input buffer> , <Size of output buffer> [, <Timeout>])

<Result>: Integer

Identifier of open port. This identifier can be used in the functions for managing the ports.
This identifier corresponds to:
the number of the relevant serial port: 1, 2, 3, ... 256 for COM1, COM2, COM3, ... COM256.
the number of the relevant parallel port: -1, -2, -3 or -4 for LPT1, LPT2, LPT3 or LPT4.
the number of the relevant infrared port: 1, 2, 3, ... 256 for IR1, IR2, IR3, ... IR256.
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.
0 if an error occurred.
Versions 25 and later
Caution: This identifier does not correspond to the serial port number.
New in version 25
Caution: This identifier does not correspond to the serial port number.
Caution: This identifier does not correspond to the serial port number.

<Port name>: Character string with quotes

Name of relevant port:
Name of serial port: COM1, COM2, COM3, ... COM256.
Name of serial port in Java: /dev/ttyS4, /dev/ttyS5, ... /dev/ttyS9.
Serial port number in Linux (for example /dev/ttyS1).
Name of parallel port: LPT1, LPT2, LPT3 or LPT4.
Versions 25 and later
Parallel port management is not available.
New in version 25
Parallel port management is not available.
Parallel port management is not available.
Name of infrared port: IR1, IR2, ... IR256.
Versions 16 and later
Infrared ports are not managed.
New in version 16
Infrared ports are not managed.
Infrared ports are not managed.

<Size of input buffer>: Integer

Size of input buffer in bytes (up to 32768).

<Size of output buffer>: Integer

Size of output buffer in bytes (up to 32768).

<Timeout>: Optional integer

Duration (expressed in milliseconds) allocated for reading or writing a character. This parameter is used to avoid a lock when a read or write problem occurs on the print port.
When <Timeout> has expired, the read or write function returns 0.
The default value of this parameter is defined at system level.
The sDefaultTimeout constant allows you to use the default timeout.
This parameter can correspond to:
an integer corresponding to the number of milliseconds,
a Duration variable,
Versions 23 and later
the direct indication of duration (1 s or 10 ms for example).
New in version 23
the direct indication of duration (1 s or 10 ms for example).
the direct indication of duration (1 s or 10 ms for example).
Versions 16 and later
No timeout will be applied if this parameter is not specified. The sDefaultTimeout constant is not available. If a timeout is specified, it will be applied to the read operations performed on the serial ports.
New in version 16
No timeout will be applied if this parameter is not specified. The sDefaultTimeout constant is not available. If a timeout is specified, it will be applied to the read operations performed on the serial ports.
No timeout will be applied if this parameter is not specified. The sDefaultTimeout constant is not available. If a timeout is specified, it will be applied to the read operations performed on the serial ports.

Remarks

Miscellaneous

A port cannot be opened if this port was not closed properly.
Important: A port must be opened by sOpen before it can be configured by sParameter.
WLanguage does not allow you to manage the control signals.
Two computers send each other characters via a port: if the second computer calls sOpen once the characters have been sent by the first computer, these characters are ignored.

Opening and initializing an infrared port by specifying its name (syntax 2)

The use of an infrared port opened by sOpen corresponds to the simulated use of a serial port. This simulation does not operate properly on some Pocket PCs.

To open an infrared port, we recommend that you use SocketConnectInfrared and SocketCreateInfrared. Therefore, the infrared port is using the IRDA protocol. This protocol is more reliable and faster for managing the IRDA-compatible devices (Pocket PCs, printers, cell phones, ...).

Remark: However, sOpen must be used to communicate with devices that are not IRDA-compatible (TV for example).

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