Skip to content

control_io_channelControlIoChannelControlIoChannelcontrol_io_channelT_control_io_channel🔗

Short description🔗

control_io_channelControlIoChannelControlIoChannelcontrol_io_channelT_control_io_channel — Perform an action on I/O channels.

Signature🔗

control_io_channel( io_channel IOChannelHandle, string Action, string Argument, out string Result )void ControlIoChannel( const HTuple& IOChannelHandle, const HTuple& Action, const HTuple& Argument, HTuple* Result )static void HOperatorSet.ControlIoChannel( HTuple IOChannelHandle, HTuple action, HTuple argument, out HTuple result )def control_io_channel( iochannel_handle: MaybeSequence[HHandle], action: str, argument: Sequence[Union[int, float, str]] ) -> Sequence[Union[int, float, str]]

Herror T_control_io_channel( const Htuple IOChannelHandle, const Htuple Action, const Htuple Argument, Htuple* Result )

static HTuple HIOChannel::ControlIoChannel( const HIOChannelArray& IOChannelHandle, const HString& Action, const HTuple& Argument )

HTuple HIOChannel::ControlIoChannel( const HString& Action, const HTuple& Argument ) const

HTuple HIOChannel::ControlIoChannel( const char* Action, const HTuple& Argument ) const

HTuple HIOChannel::ControlIoChannel( const wchar_t* Action, const HTuple& Argument ) const (Windows only)

static HTuple HIOChannel.ControlIoChannel( HIOChannel[] IOChannelHandle, string action, HTuple argument )

HTuple HIOChannel.ControlIoChannel( string action, HTuple argument )

Description🔗

control_io_channelControlIoChannel 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.

Execution information🔗

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🔗

IOChannelHandleIOChannelHandleiochannel_handle (input_control) io_channel(-array) → (handle)HTuple (HHandle)HIOChannel, HTuple (IntPtr)MaybeSequence[HHandle]Htuple (handle)

Handles of the opened I/O channels.

Actionactionaction (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Name of the action to perform.

Argumentargumentargument (input_control) string-array → (string / integer / real)HTuple (HString / Hlong / double)HTuple (string / int / long / double)Sequence[Union[int, float, str]]Htuple (char* / Hlong / double)

List of arguments for the action.

Default: [][]

Resultresultresult (output_control) string-array → (string / integer / real)HTuple (HString / Hlong / double)HTuple (string / int / long / double)Sequence[Union[int, float, str]]Htuple (char* / Hlong / double)

List of values returned by the action.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

open_io_channelOpenIoChannel

Module🔗

Foundation