Operator Reference

HALCON Operator Reference / System / I/O Devices

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

ClassesClasses | | Operators

control_io_channelT_control_io_channelControlIoChannelControlIoChannelcontrol_io_channel (Operator)

control_io_channelT_control_io_channelControlIoChannelControlIoChannelcontrol_io_channel — Perform an action on I/O channels.

Signature

control_io_channel( : : IOChannelHandle, Action, Argument : Result)

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

void ControlIoChannel(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 void HOperatorSet.ControlIoChannel(HTuple IOChannelHandle, HTuple action, HTuple argument, out HTuple result)

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

HTuple HIOChannel.ControlIoChannel(string action, HTuple argument)

def control_io_channel(iochannel_handle: MaybeSequence[HHandle], action: str, argument: Sequence[Union[int, float, str]]) -> Sequence[Union[int, float, str]]

Description

control_io_channelcontrol_io_channelControlIoChannelControlIoChannelcontrol_io_channel 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

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleiochannel_handle (input_control)  io_channel(-array) → HIOChannel, HTupleMaybeSequence[HHandle]HTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handles of the opened I/O channels.

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

Name of the action to perform.

ArgumentArgumentArgumentargumentargument (input_control)  string-array → HTupleSequence[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 values returned by the action.

Result

If the parameters are valid, the operator control_io_channelcontrol_io_channelControlIoChannelControlIoChannelcontrol_io_channel 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_channelopen_io_channelOpenIoChannelOpenIoChannelopen_io_channel

Module

Foundation

---

ClassesClasses | | Operators