Skip to content

control_io_deviceControlIoDeviceControlIoDevicecontrol_io_deviceT_control_io_device🔗

Short description🔗

control_io_deviceControlIoDeviceControlIoDevicecontrol_io_deviceT_control_io_device — Perform an action on the I/O device.

Signature🔗

control_io_device( io_device IODeviceHandle, string Action, string Argument, out string Result )void ControlIoDevice( const HTuple& IODeviceHandle, const HTuple& Action, const HTuple& Argument, HTuple* Result )static void HOperatorSet.ControlIoDevice( HTuple IODeviceHandle, HTuple action, HTuple argument, out HTuple result )def control_io_device( iodevice_handle: HHandle, action: str, argument: MaybeSequence[Union[int, float, str]] ) -> Sequence[Union[int, float, str]]

Herror T_control_io_device( const Htuple IODeviceHandle, const Htuple Action, const Htuple Argument, Htuple* Result )

HTuple HIODevice::ControlIoDevice( const HString& Action, const HTuple& Argument ) const

HTuple HIODevice::ControlIoDevice( const HString& Action, const HString& Argument ) const

HTuple HIODevice::ControlIoDevice( const char* Action, const char* Argument ) const

HTuple HIODevice::ControlIoDevice( const wchar_t* Action, const wchar_t* Argument ) const (Windows only)

HTuple HIODevice.ControlIoDevice( string action, HTuple argument )

HTuple HIODevice.ControlIoDevice( string action, string argument )

Description🔗

control_io_deviceControlIoDevice performs an action on the I/O device. 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🔗

IODeviceHandleIODeviceHandleiodevice_handle (input_control) io_device → (handle)HTuple (HHandle)HIODevice, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the opened I/O device.

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)MaybeSequence[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 result values returned by the action.

Result🔗

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

Module🔗

Foundation