read_io_channelT_read_io_channelReadIoChannelReadIoChannelread_io_channel (Operator)
Name
read_io_channelT_read_io_channelReadIoChannelReadIoChannelread_io_channel — Read a value from the specified I/O channels.
Signature
def read_io_channel(iochannel_handle: MaybeSequence[HHandle]) -> Tuple[Sequence[HTupleElementType], Sequence[int]]
Description
read_io_channelread_io_channelReadIoChannelReadIoChannelReadIoChannelread_io_channel reads input values from the specified
transmission channels. The channels are passed in
IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleiochannel_handle and can be opened and configured by
open_io_channelopen_io_channelOpenIoChannelOpenIoChannelOpenIoChannelopen_io_channel, the values are returned in
ValueValueValueValuevaluevalue. The parameter StatusStatusStatusStatusstatusstatus returns for each read
value in ValueValueValueValuevaluevalue a quality message. The value 0
indicates that the corresponding value of ValueValueValueValuevaluevalue could be
read. Any other status value depends on the interface. Please refer
to the interface-specific documentation in the directory
doc/html/reference/io for further explanation.
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
IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleiochannel_handle (input_control) io_channel(-array) → HIOChannel, HTupleMaybeSequence[HHandle]HTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handles of the opened I/O channels.
ValueValueValueValuevaluevalue (output_control) tuple-array → HTupleSequence[HTupleElementType]HTupleHtuple (integer / real / string / handle) (int / long / double / string / HHandle) (Hlong / double / HString / HHandle) (Hlong / double / char* / handle)
Read value.
StatusStatusStatusStatusstatusstatus (output_control) integer-array → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Status of read value.
Result
If the parameters are valid, the operator
read_io_channelread_io_channelReadIoChannelReadIoChannelReadIoChannelread_io_channel returns the value 2 (H_MSG_TRUE). If necessary an
exception is raised. In this case, an extended error information may be
set and can be queried with the operator get_extended_error_infoget_extended_error_infoGetExtendedErrorInfoGetExtendedErrorInfoGetExtendedErrorInfoget_extended_error_info.
Possible Predecessors
open_io_channelopen_io_channelOpenIoChannelOpenIoChannelOpenIoChannelopen_io_channel,
set_io_channel_paramset_io_channel_paramSetIoChannelParamSetIoChannelParamSetIoChannelParamset_io_channel_param
Possible Successors
close_io_channelclose_io_channelCloseIoChannelCloseIoChannelCloseIoChannelclose_io_channel
See also
write_io_channelwrite_io_channelWriteIoChannelWriteIoChannelWriteIoChannelwrite_io_channel,
query_io_devicequery_io_deviceQueryIoDeviceQueryIoDeviceQueryIoDevicequery_io_device,
set_io_channel_paramset_io_channel_paramSetIoChannelParamSetIoChannelParamSetIoChannelParamset_io_channel_param
Module
Foundation