Operator Reference

write_io_channelT_write_io_channelWriteIoChannelWriteIoChannelwrite_io_channel (Operator)

write_io_channelT_write_io_channelWriteIoChannelWriteIoChannelwrite_io_channel — Write a value to the specified I/O channels.

Signature

write_io_channel( : : IOChannelHandle, Value : Status)

Herror T_write_io_channel(const Htuple IOChannelHandle, const Htuple Value, Htuple* Status)

void WriteIoChannel(const HTuple& IOChannelHandle, const HTuple& Value, HTuple* Status)

static HTuple HIOChannel::WriteIoChannel(const HIOChannelArray& IOChannelHandle, const HTuple& Value)

HTuple HIOChannel::WriteIoChannel(const HTuple& Value) const

static void HOperatorSet.WriteIoChannel(HTuple IOChannelHandle, HTuple value, out HTuple status)

static HTuple HIOChannel.WriteIoChannel(HIOChannel[] IOChannelHandle, HTuple value)

HTuple HIOChannel.WriteIoChannel(HTuple value)

def write_io_channel(iochannel_handle: MaybeSequence[HHandle], value: Sequence[HTupleElementType]) -> Sequence[int]

Description

write_io_channelwrite_io_channelWriteIoChannelWriteIoChannelwrite_io_channel writes values to the specified transmission channels. The channels are passed in IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleiochannel_handle and can be opened and configured by open_io_channelopen_io_channelOpenIoChannelOpenIoChannelopen_io_channel, the values are passed to ValueValueValuevaluevalue. The parameter StatusStatusStatusstatusstatus returns for each written value in ValueValueValuevaluevalue a quality message. The value 0 indicates that the corresponding value of ValueValueValuevaluevalue 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

IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleiochannel_handle (input_control)  io_channel(-array) HIOChannel, HTupleMaybeSequence[HHandle]HTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handles of the opened I/O channels.

ValueValueValuevaluevalue (input_control)  tuple-array HTupleSequence[HTupleElementType]HTupleHtuple (integer / real / string / handle) (int / long / double / string / HHandle) (Hlong / double / HString / HHandle) (Hlong / double / char* / handle)

Write values.

StatusStatusStatusstatusstatus (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_channelWriteIoChannelWriteIoChannelwrite_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_infoGetExtendedErrorInfoGetExtendedErrorInfoget_extended_error_info.

Possible Predecessors

open_io_channelopen_io_channelOpenIoChannelOpenIoChannelopen_io_channel, set_io_channel_paramset_io_channel_paramSetIoChannelParamSetIoChannelParamset_io_channel_param

Possible Successors

close_io_channelclose_io_channelCloseIoChannelCloseIoChannelclose_io_channel

See also

read_io_channelread_io_channelReadIoChannelReadIoChannelread_io_channel, open_io_channelopen_io_channelOpenIoChannelOpenIoChannelopen_io_channel, query_io_devicequery_io_deviceQueryIoDeviceQueryIoDevicequery_io_device, set_io_channel_paramset_io_channel_paramSetIoChannelParamSetIoChannelParamset_io_channel_param

Module

Foundation