Operator Reference

HALCON Operator Reference / System / I/O Devices

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

ClassesClasses | | Operators

get_io_channel_paramT_get_io_channel_paramGetIoChannelParamGetIoChannelParamget_io_channel_param (Operator)

get_io_channel_paramT_get_io_channel_paramGetIoChannelParamGetIoChannelParamget_io_channel_param — Query specific parameters of I/O channels.

Signature

get_io_channel_param( : : IOChannelHandle, GenParamName : GenParamValue)

Herror T_get_io_channel_param(const Htuple IOChannelHandle, const Htuple GenParamName, Htuple* GenParamValue)

void GetIoChannelParam(const HTuple& IOChannelHandle, const HTuple& GenParamName, HTuple* GenParamValue)

static HTuple HIOChannel::GetIoChannelParam(const HIOChannelArray& IOChannelHandle, const HTuple& GenParamName)

HTuple HIOChannel::GetIoChannelParam(const HString& GenParamName) const

HTuple HIOChannel::GetIoChannelParam(const char* GenParamName) const

HTuple HIOChannel::GetIoChannelParam(const wchar_t* GenParamName) const   ( Windows only)

static void HOperatorSet.GetIoChannelParam(HTuple IOChannelHandle, HTuple genParamName, out HTuple genParamValue)

static HTuple HIOChannel.GetIoChannelParam(HIOChannel[] IOChannelHandle, HTuple genParamName)

HTuple HIOChannel.GetIoChannelParam(string genParamName)

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

Description

get_io_channel_paramget_io_channel_paramGetIoChannelParamGetIoChannelParamget_io_channel_param queries settings of specific I/O transmission channels. The query parameters are passed in GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name, the corresponding configuration values are returned in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value. IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleiochannel_handle specifies the channels returned in open_io_channelopen_io_channelOpenIoChannelOpenIoChannelopen_io_channel for a specific device instance.

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) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Parameter names.

Default: 'param_name' "param_name" "param_name" "param_name" "param_name"

Suggested values: 'io_channel_name'"io_channel_name""io_channel_name""io_channel_name""io_channel_name", 'param_name'"param_name""param_name""param_name""param_name"

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (output_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.

Result

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

Module

Foundation

---

ClassesClasses | | Operators