Operator Reference

HALCON Operator Reference / System / I/O Devices

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

ClassesClasses | | Operators

set_io_channel_paramT_set_io_channel_paramSetIoChannelParamSetIoChannelParamset_io_channel_param (Operator)

set_io_channel_paramT_set_io_channel_paramSetIoChannelParamSetIoChannelParamset_io_channel_param — Set specific parameters of I/O channels.

Signature

set_io_channel_param( : : IOChannelHandle, GenParamName, GenParamValue : )

Herror T_set_io_channel_param(const Htuple IOChannelHandle, const Htuple GenParamName, const Htuple GenParamValue)

void SetIoChannelParam(const HTuple& IOChannelHandle, const HTuple& GenParamName, const HTuple& GenParamValue)

static void HIOChannel::SetIoChannelParam(const HIOChannelArray& IOChannelHandle, const HTuple& GenParamName, const HTuple& GenParamValue)

void HIOChannel::SetIoChannelParam(const HTuple& GenParamName, const HTuple& GenParamValue) const

static void HOperatorSet.SetIoChannelParam(HTuple IOChannelHandle, HTuple genParamName, HTuple genParamValue)

static void HIOChannel.SetIoChannelParam(HIOChannel[] IOChannelHandle, HTuple genParamName, HTuple genParamValue)

void HIOChannel.SetIoChannelParam(HTuple genParamName, HTuple genParamValue)

def set_io_channel_param(iochannel_handle: MaybeSequence[HHandle], gen_param_name: Sequence[str], gen_param_value: Sequence[HTupleElementType]) -> None

Description

set_io_channel_paramset_io_channel_paramSetIoChannelParamSetIoChannelParamset_io_channel_param (re)configures the given transmission channels. The configuration parameters are passed in GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name, the corresponding values are passed in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value. IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleiochannel_handle specifies the transmission channels returned in open_io_channelopen_io_channelOpenIoChannelOpenIoChannelopen_io_channel.

Please check the directory doc/html/reference/io for documentation about your specific I/O device interface, where all supported channel-specific parameters are listed.

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.

GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  string-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Parameter names.

Default: []

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control)  string-array → HTupleSequence[HTupleElementType]HTupleHtuple (string / integer / real / handle) (string / int / long / double / HHandle) (HString / Hlong / double / HHandle) (char* / Hlong / double / handle)

Parameter values to set.

Default: []

Result

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

Possible Successors

read_io_channelread_io_channelReadIoChannelReadIoChannelread_io_channel, write_io_channelwrite_io_channelWriteIoChannelWriteIoChannelwrite_io_channel

See also

open_io_channelopen_io_channelOpenIoChannelOpenIoChannelopen_io_channel, query_io_devicequery_io_deviceQueryIoDeviceQueryIoDevicequery_io_device, get_io_channel_paramget_io_channel_paramGetIoChannelParamGetIoChannelParamget_io_channel_param, read_io_channelread_io_channelReadIoChannelReadIoChannelread_io_channel, write_io_channelwrite_io_channelWriteIoChannelWriteIoChannelwrite_io_channel

Module

Foundation

---

ClassesClasses | | Operators