Operator Reference

HALCON Operator Reference / System / I/O Devices

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

control_io_deviceT_control_io_deviceControlIoDeviceControlIoDevicecontrol_io_device (Operator)

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

Signature

control_io_device( : : IODeviceHandle, Action, Argument : Result)

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

void ControlIoDevice(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)

static void HOperatorSet.ControlIoDevice(HTuple IODeviceHandle, HTuple action, HTuple argument, out HTuple result)

HTuple HIODevice.ControlIoDevice(string action, HTuple argument)

HTuple HIODevice.ControlIoDevice(string action, string argument)

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_deviceControlIoDeviceControlIoDevicecontrol_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

IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleiodevice_handle (input_control)  io_device → HIODevice, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the opened I/O device.

ActionActionActionactionaction (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Name of the action to perform.

ArgumentArgumentArgumentargumentargument (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: []

ResultResultResultresultresult (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_deviceControlIoDeviceControlIoDevicecontrol_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_infoGetExtendedErrorInfoGetExtendedErrorInfoget_extended_error_info.

Possible Predecessors

open_io_deviceopen_io_deviceOpenIoDeviceOpenIoDeviceopen_io_device

Module

Foundation

---

ClassesClasses | | Operators