write_io_channelT_write_io_channelWriteIoChannelWriteIoChannelwrite_io_channel (Operator)
Name
write_io_channelT_write_io_channelWriteIoChannelWriteIoChannelwrite_io_channel — Write a value to the specified I/O channels.
Signature
def write_io_channel(iochannel_handle: MaybeSequence[HHandle], value: Sequence[Union[int, float, str]]) -> Sequence[int]
Description
write_io_channelwrite_io_channelWriteIoChannelWriteIoChannelWriteIoChannelwrite_io_channel writes values to 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 passed to ValueValueValueValuevaluevalue. The parameter StatusStatusStatusStatusstatusstatus returns
for each written value in ValueValueValueValuevaluevalue a quality message. The
value 0 indicates that the corresponding value of
ValueValueValueValuevaluevalue could be written. 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 (input_control) tuple-array → HTupleSequence[Union[int, float, str]]HTupleHtuple (integer / real / string) (int / long / double / string) (Hlong / double / HString) (Hlong / double / char*)
Write values.
StatusStatusStatusStatusstatusstatus (output_control) integer-array → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Status of written values.
Result
If the parameters are valid, the operator
write_io_channelwrite_io_channelWriteIoChannelWriteIoChannelWriteIoChannelwrite_io_channel returns the value 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
read_io_channelread_io_channelReadIoChannelReadIoChannelReadIoChannelread_io_channel,
open_io_channelopen_io_channelOpenIoChannelOpenIoChannelOpenIoChannelopen_io_channel,
query_io_devicequery_io_deviceQueryIoDeviceQueryIoDeviceQueryIoDevicequery_io_device,
set_io_channel_paramset_io_channel_paramSetIoChannelParamSetIoChannelParamSetIoChannelParamset_io_channel_param
Module
Foundation