sEscape (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

sEscape (Function)

In french: sEchap

Runs different functions that directly affect the bits of serial port, parallel port or infrared port, independently of the communication protocol. These functions are used to manage:

the DTR signal,
the RTS signal,
the XOFF and XON characters.

Remarks:

The port must be opened beforehand (sOpen).
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.
This function returns information regarding the server.

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

// Clears the DTR signal
sEscape(PortNum, "CLRDTR")

Syntax

<Result> = sEscape(<Port number> , <Function>)

<Result>: Boolean

True if the function was run,
False otherwise. If the port was not opened beforehand (by sOpen), sEscape has no effect.

<Port number>: Integer

Number of the relevant serial port: 1, 2, 3, ... 32 for COM1, COM2, COM3, ... COM32.
Number of the relevant parallel port: -1, -2, -3 or -4 for LPT1, LPT2, LPT3 or LPT4.
Number of the relevant infrared port: 1, 2, 3, ... 32 for IR1, IR2, IR3, ... IR32.
Versions 16 and later
Infrared ports are not managed.
New in version 16
Infrared ports are not managed.
Infrared ports are not managed.
Port identifier returned by sOpen (if this function was called with a port name).
Versions 25 and later
Only this type of parameter is available.
New in version 25
Only this type of parameter is available.
Only this type of parameter is available.

<Function>: Character string (with quotes)

Function to run:
CLRBREAK Clears the "Break line" signal.
Versions 16 and later
This function is not supported in Java.
New in version 16
This function is not supported in Java.
This function is not supported in Java.
CLRDTR Clears the DTR signal.
CLRRTS Clears the RTS signal.
RESETDEV Re-initializes the device if possible.
Versions 16 and later
This function is not supported in Java.
New in version 16
This function is not supported in Java.
This function is not supported in Java.
SETBREAK Enables the "Break Line" signal.
Versions 16 and later
This function is not supported in Java.
New in version 16
This function is not supported in Java.
This function is not supported in Java.
SETDTR Sends the DTR signal.
SETRTS Sends the RTS signal.
SETXOFF The transmission behaves like if the XOFF character was received.
Versions 16 and later
This function is not supported in Java.
New in version 16
This function is not supported in Java.
This function is not supported in Java.
SETXON The transmission behaves like if the XON character was received.
Versions 16 and later
This function is not supported in Java.
New in version 16
This function is not supported in Java.
This function is not supported in Java.

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