ClassesClassesClassesClasses | | | | Operators

read_serialread_serialReadSerialread_serialReadSerialReadSerial (Operator)


read_serialread_serialReadSerialread_serialReadSerialReadSerial — Read from a serial device.


read_serial( : : SerialHandle, NumCharacters : Data)

Herror read_serial(const Hlong SerialHandle, const Hlong NumCharacters, Hlong* Data)

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

Herror read_serial(const HTuple& SerialHandle, const HTuple& NumCharacters, Hlong* Data)

Herror read_serial(const HTuple& SerialHandle, const HTuple& NumCharacters, HTuple* Data)

HTuple HSerial::ReadSerial(const HTuple& NumCharacters) const

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

HTuple HSerial::ReadSerial(Hlong NumCharacters) const

void HOperatorSetX.ReadSerial(
[in] VARIANT SerialHandle, [in] VARIANT NumCharacters, [out] VARIANT* Data)

VARIANT HSerialX.ReadSerial([in] Hlong NumCharacters)

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

HTuple HSerial.ReadSerial(int numCharacters)


read_serialread_serialReadSerialread_serialReadSerialReadSerial tries to read NumCharactersNumCharactersNumCharactersNumCharactersNumCharactersnumCharacters from the serial device given in SerialHandleSerialHandleSerialHandleSerialHandleSerialHandleserialHandle. The read characters are returned in DataDataDataDataDatadata 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_paramSetSerialParamset_serial_paramSetSerialParamSetSerialParam, read_serialread_serialReadSerialread_serialReadSerialReadSerial 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 DataDataDataDataDatadata.



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

Serial interface handle.

NumCharactersNumCharactersNumCharactersNumCharactersNumCharactersnumCharacters (input_control)  integer HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

Number of characters to read.

Default value: 1

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

DataDataDataDataDatadata (output_control)  integer(-array) HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (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_serialReadSerialread_serialReadSerialReadSerial returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.

Possible Predecessors


See also




ClassesClassesClassesClasses | | | | Operators