ClassesClassesClassesClasses | | | | Operators

control_io_channelT_control_io_channelControlIoChannelcontrol_io_channelControlIoChannelControlIoChannel (Operator)

Name

control_io_channelT_control_io_channelControlIoChannelcontrol_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)

Herror control_io_channel(const HTuple& IOChannelHandle, const HTuple& ParamAction, const HTuple& ParamArgument, HTuple* GenParamValue)

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

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

void HOperatorSetX.ControlIoChannel(
[in] VARIANT IOChannelHandle, [in] VARIANT ParamAction, [in] VARIANT ParamArgument, [out] VARIANT* GenParamValue)

VARIANT HIOChannelX.ControlIoChannel(
[in] BSTR ParamAction, [in] VARIANT ParamArgument)

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_channelControlIoChannelcontrol_io_channelControlIoChannelControlIoChannel 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""doc/html/reference/io".

Parallelization

Parameters

IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandle (input_control)  io_channel(-array) HIOChannel, HTupleHTupleHIOChannel, HTupleHIOChannelX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handles of the opened I/O channels.

ParamActionParamActionParamActionParamActionParamActionparamAction (input_control)  string HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Name of the action to perform.

ParamArgumentParamArgumentParamArgumentParamArgumentParamArgumentparamArgument (input_control)  string-array HTupleHTupleHTupleVARIANTHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double) (BSTR / Hlong / double) (char* / Hlong / double)

List of arguments for the action.

Default value: []

GenParamValueGenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (output_control)  string-array HTupleHTupleHTupleVARIANTHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double) (BSTR / Hlong / double) (char* / Hlong / double)

List of values returned by the action.

Result

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

Possible Predecessors

open_io_channelopen_io_channelOpenIoChannelopen_io_channelOpenIoChannelOpenIoChannel

Module

Foundation


ClassesClassesClassesClasses | | | | Operators