sWrite (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Various
Transmission between two computers that use character strings in different formats (UNICODE and ANSI)
Using an external library: RXTX

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

sWrite (Function)

In french: sEcrit

Writes a character string into the output buffer of the specified serial port, parallel port or infrared port. The end of writing can be checked by sInExitQueue.

Remarks:

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

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 COM2 port is opened
PortNum = sOpen("COM2", 2000, 2000) // Open COM2
IF PortNum <> 0 THEN
sMessage is string
// Send a message to the output buffer of COM2
sWrite(PortNum, sMessage)
// Wait for the end of the write operation
LOOP
IF sInExitQueue(2) = 0 THEN BREAK
END
Info("End of write operation")
END

Syntax

Writing a character string into the output buffer of a port Hide the details

<Result> = sWrite(<Port number> , <String to write>)

<Result>: Integer

Number of characters written,
0 if time-out is over and if the writing was not performed.

<Port number>: Integer

Identifier of relevant port:
Number of serial port: 1, 2, 3, ... 32 for COM1, COM2, COM3, ... COM32.
Number of parallel port: -1, -2, -3 or -4 for LPT1, LPT2, LPT3 or LPT4.
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 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.

<String to write>: Character string (with quotes)

Character string that must be written into the output buffer.

Writing a buffer into the output buffer of a port Hide the details

<Result> = sWrite(<Port number> , <Buffer to write>)

<Result>: Integer

Number of characters written,
0 if time-out is over and if the writing was not performed.

<Port number>: Integer

Identifier of relevant port:
Number of serial port: 1, 2, 3, ... 32 for COM1, COM2, COM3, ... COM32.
Number of parallel port: -1, -2, -3 or -4 for LPT1, LPT2, LPT3 or LPT4.
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 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.

<Buffer to write>: Buffer

Buffer that must be written into the output buffer.

Remarks

Various

sWrite has no effect if the port was not opened by sOpen.
A 32-bit application is locked during the duration of the transfer. To avoid this lock, the time-out between two write operations must be specified in sOpen. When the time-out is over and if the writing was not performed, sWrite returns 0.
Versions 16 and later
sWrite is a locking function during the transfer even if a time-out was specified in sOpen.
New in version 16
sWrite is a locking function during the transfer even if a time-out was specified in sOpen.
sWrite is a locking function during the transfer even if a time-out was specified in sOpen.
The time required to transfer the string depends on the transmission speed.
The string or the buffer is automatically transferred.
WLanguage does not allow you to manage the control signals.

Transmission between two computers that use character strings in different formats (UNICODE and ANSI)

Some conversions are required to perform a transmission between two computers that use different formats of character strings (Windows (ANSI) and Windows Mobile (UNICODE) for example):


Format of character strings on the current computer	Write operation (sWrite)	Read operation (sRead)
Format of character strings on the current computer	Write operation (sWrite)	String in ANSI format	String in UNICODE format
ANSI (PC running Windows XP for example)	The character string will be in ANSI format	No conversion is required	Conversion required (UnicodeToAnsi)
UNICODE (Pocket PC running Windows CE for example)	The character string will be in UNICODE format	Conversion required (AnsiToUnicode)	No conversion is required

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