control_io_channelT_control_io_channelControlIoChannelControlIoChannel (Operator)

Name

control_io_channelT_control_io_channelControlIoChannelControlIoChannel — Perform an action on I/O channels.

Signature

control_io_channel( : : IOChannelHandle, ParamAction, ParamArgument : GenParamValue)

Herror T_control_io_channel(const Htuple IOChannelHandle, const Htuple ParamAction, const Htuple ParamArgument, Htuple* GenParamValue)

void ControlIoChannel(const HTuple& IOChannelHandle, const HTuple& ParamAction, const HTuple& ParamArgument, HTuple* GenParamValue)

static HTuple HIOChannel::ControlIoChannel(const HIOChannelArray& IOChannelHandle, const HString& ParamAction, const HTuple& ParamArgument)

HTuple HIOChannel::ControlIoChannel(const HString& ParamAction, const HTuple& ParamArgument) const

HTuple HIOChannel::ControlIoChannel(const char* ParamAction, const HTuple& ParamArgument) const

HTuple HIOChannel::ControlIoChannel(const wchar_t* ParamAction, const HTuple& ParamArgument) const   (Windows only)

static void HOperatorSet.ControlIoChannel(HTuple IOChannelHandle, HTuple paramAction, HTuple paramArgument, out HTuple genParamValue)

static HTuple HIOChannel.ControlIoChannel(HIOChannel[] IOChannelHandle, string paramAction, HTuple paramArgument)

HTuple HIOChannel.ControlIoChannel(string paramAction, HTuple paramArgument)

Description

control_io_channelcontrol_io_channelControlIoChannelControlIoChannelControlIoChannel performs an action on the specified I/O channels. The supported parameters are interface-specific and listed in the corresponding documentation of the used I/O interface that can be found in the directory 'doc/html/reference/io'"doc/html/reference/io""doc/html/reference/io""doc/html/reference/io""doc/html/reference/io".

Execution Information

Parameters

IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandle (input_control)  io_channel(-array) HIOChannel, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handles of the opened I/O channels.

ParamActionParamActionParamActionParamActionparamAction (input_control)  string HTupleHTupleHtuple (string) (string) (HString) (char*)

Name of the action to perform.

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

List of arguments for the action.

Default value: []

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (output_control)  string-array HTupleHTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)

List of values returned by the action.

Result

If the parameters are valid, the operator control_io_channelcontrol_io_channelControlIoChannelControlIoChannelControlIoChannel 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

Module

Foundation