ClassesClasses | | Operators

write_io_channelT_write_io_channelWriteIoChannelWriteIoChannel (Operator)

Name

write_io_channelT_write_io_channelWriteIoChannelWriteIoChannel — 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)

Description

write_io_channelwrite_io_channelWriteIoChannelWriteIoChannelWriteIoChannel writes values to the specified transmission channels. The channels are passed in IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandle and can be opened and configured by open_io_channelopen_io_channelOpenIoChannelOpenIoChannelOpenIoChannel, 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'"doc/html/reference/io""doc/html/reference/io""doc/html/reference/io""doc/html/reference/io" for further explanation.

Execution Information

Parameters

IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandle (input_control)  io_channel(-array) HIOChannel, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Handles of the opened I/O channels.

ValueValueValueValuevalue (input_control)  tuple-array HTupleHTupleHtuple (integer / real / string) (int / long / double / string) (Hlong / double / HString) (Hlong / double / char*)

Write values.

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

Status of written values.

Result

If the parameters are valid, the operator write_io_channelwrite_io_channelWriteIoChannelWriteIoChannelWriteIoChannel 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_infoGetExtendedErrorInfoGetExtendedErrorInfoGetExtendedErrorInfo.

Possible Predecessors

open_io_channelopen_io_channelOpenIoChannelOpenIoChannelOpenIoChannel, set_io_channel_paramset_io_channel_paramSetIoChannelParamSetIoChannelParamSetIoChannelParam

Possible Successors

close_io_channelclose_io_channelCloseIoChannelCloseIoChannelCloseIoChannel

See also

read_io_channelread_io_channelReadIoChannelReadIoChannelReadIoChannel, open_io_channelopen_io_channelOpenIoChannelOpenIoChannelOpenIoChannel, query_io_devicequery_io_deviceQueryIoDeviceQueryIoDeviceQueryIoDevice, set_io_channel_paramset_io_channel_paramSetIoChannelParamSetIoChannelParamSetIoChannelParam

Module

Foundation


ClassesClasses | | Operators