read_serialT_read_serialReadSerialReadSerial (Operator)


read_serialT_read_serialReadSerialReadSerial — Read from a serial device.


read_serial( : : SerialHandle, NumCharacters : Data)

Herror T_read_serial(const Htuple SerialHandle, const Htuple NumCharacters, Htuple* Data)

void ReadSerial(const HTuple& SerialHandle, const HTuple& NumCharacters, HTuple* Data)

HTuple HSerial::ReadSerial(Hlong NumCharacters) const

static void HOperatorSet.ReadSerial(HTuple serialHandle, HTuple numCharacters, out HTuple data)

HTuple HSerial.ReadSerial(int numCharacters)


read_serialread_serialReadSerialReadSerialReadSerial tries to read NumCharactersNumCharactersNumCharactersNumCharactersnumCharacters from the serial device given in SerialHandleSerialHandleSerialHandleSerialHandleserialHandle. The read characters are returned in DataDataDataDatadata as a tuple of integers. This allows to read NUL characters, which would otherwise be interpreted as the end of a string. If the timeout of the serial device has been set to a value greater than 0 with set_serial_paramset_serial_paramSetSerialParamSetSerialParamSetSerialParam, read_serialread_serialReadSerialReadSerialReadSerial waits at most as long for the arrival of the first character as indicated by the timeout. Otherwise, the operator returns immediately. In any case, the number of characters available at the time of return are passed back to the caller, i.e., fewer characters than requested can be returned. This can be checked by the length of the tuple DataDataDataDatadata.

Execution Information


SerialHandleSerialHandleSerialHandleSerialHandleserialHandle (input_control)  serial HSerial, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Serial interface handle.

NumCharactersNumCharactersNumCharactersNumCharactersnumCharacters (input_control)  integer HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of characters to read.

Default value: 1

Suggested values: 1, 2, 3, 4, 5, 10, 20, 40, 100

DataDataDataDatadata (output_control)  integer(-array) HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Read characters (as tuple of integers).


If the parameters are correct and the read from the device was successful, the operator read_serialread_serialReadSerialReadSerialReadSerial returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.

Possible Predecessors


See also