write_serialT_write_serialWriteSerialWriteSerial (Operator)

Name

write_serialT_write_serialWriteSerialWriteSerial — Write to a serial connection.

Signature

write_serial( : : SerialHandle, Data : )

Description

write_serialwrite_serialWriteSerialWriteSerialWriteSerial writes the characters given in DataDataDataDatadata to the serial device given by SerialHandleSerialHandleSerialHandleSerialHandleserialHandle. The data to be written is passed as a tuple of integers. This allows to write NUL characters, which would otherwise be interpreted as the end of a string. write_serialwrite_serialWriteSerialWriteSerialWriteSerial always waits until all data has been transmitted, i.e., a timeout for writing cannot be set.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

SerialHandleSerialHandleSerialHandleSerialHandleserialHandle (input_control) serial → (handle)

Serial interface handle.

DataDataDataDatadata (input_control) integer(-array) → (integer)

Characters to write (as tuple of integers).

Result

If the parameters are correct and the write to the device was successful, the operator write_serialwrite_serialWriteSerialWriteSerialWriteSerial returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.

Possible Predecessors

open_serialopen_serialOpenSerialOpenSerialOpenSerial

Module

Foundation

Operators