control_io_deviceT_control_io_deviceControlIoDeviceControlIoDevicecontrol_io_device (Operator)
Name
control_io_deviceT_control_io_deviceControlIoDeviceControlIoDevicecontrol_io_device — Perform an action on the I/O device.
Signature
def control_io_device(iodevice_handle: HHandle, action: str, argument: MaybeSequence[Union[int, float, str]]) -> Sequence[Union[int, float, str]]
Description
control_io_devicecontrol_io_deviceControlIoDeviceControlIoDeviceControlIoDevicecontrol_io_device 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
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleiodevice_handle (input_control) io_device → HIODevice, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the opened I/O device.
ActionActionActionActionactionaction (input_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Name of the action to perform.
ArgumentArgumentArgumentArgumentargumentargument (input_control) string(-array) → HTupleMaybeSequence[Union[int, float, str]]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)
List of arguments for the action.
Default value: []
ResultResultResultResultresultresult (output_control) string-array → HTupleSequence[Union[int, float, str]]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)
List of result values returned by the action.
Result
If the parameters are valid, the operator control_io_devicecontrol_io_deviceControlIoDeviceControlIoDeviceControlIoDevicecontrol_io_device
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_infoGetExtendedErrorInfoGetExtendedErrorInfoGetExtendedErrorInfoget_extended_error_info.
Possible Predecessors
open_io_deviceopen_io_deviceOpenIoDeviceOpenIoDeviceOpenIoDeviceopen_io_device
Module
Foundation