ClassesClassesClassesClasses | | | | Operators

write_serialwrite_serialWriteSerialwrite_serialWriteSerialWriteSerial (Operator)

Name

write_serialwrite_serialWriteSerialwrite_serialWriteSerialWriteSerial — Write to a serial connection.

Signature

write_serial( : : SerialHandle, Data : )

Herror write_serial(const Hlong SerialHandle, const Hlong Data)

Herror T_write_serial(const Htuple SerialHandle, const Htuple Data)

Herror write_serial(const HTuple& SerialHandle, const HTuple& Data)

void HSerial::WriteSerial(const HTuple& Data) const

void WriteSerial(const HTuple& SerialHandle, const HTuple& Data)

void HSerial::WriteSerial(const HTuple& Data) const

void HSerial::WriteSerial(Hlong Data) const

void HOperatorSetX.WriteSerial(
[in] VARIANT SerialHandle, [in] VARIANT Data)

void HSerialX.WriteSerial([in] VARIANT Data)

static void HOperatorSet.WriteSerial(HTuple serialHandle, HTuple data)

void HSerial.WriteSerial(HTuple data)

void HSerial.WriteSerial(int data)

Description

write_serialwrite_serialWriteSerialwrite_serialWriteSerialWriteSerial writes the characters given in DataDataDataDataDatadata to the serial device given by SerialHandleSerialHandleSerialHandleSerialHandleSerialHandleserialHandle. 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_serialWriteSerialwrite_serialWriteSerialWriteSerial always waits until all data has been transmitted, i.e., a timeout for writing cannot be set.

Parallelization

Parameters

SerialHandleSerialHandleSerialHandleSerialHandleSerialHandleserialHandle (input_control)  serial_id HSerial, HTupleHTupleHSerial, HTupleHSerialX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Serial interface handle.

DataDataDataDataDatadata (input_control)  integer(-array) HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

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_serialWriteSerialwrite_serialWriteSerialWriteSerial returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.

Possible Predecessors

open_serialopen_serialOpenSerialopen_serialOpenSerialOpenSerial

See also

read_serialread_serialReadSerialread_serialReadSerialReadSerial

Module

Foundation


ClassesClassesClassesClasses | | | | Operators