HALCON 18.05 / HALCON Operator Reference / System / I/O Devices
ClassesClasses | | Operators

get_io_channel_paramT_get_io_channel_paramGetIoChannelParamGetIoChannelParam (Operator)

Name

get_io_channel_paramT_get_io_channel_paramGetIoChannelParamGetIoChannelParam — 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

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

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

HTuple HIOChannel.GetIoChannelParam(string genParamName)

Description

get_io_channel_paramget_io_channel_paramGetIoChannelParamGetIoChannelParamGetIoChannelParam queries settings of specific I/O transmission channels. The query parameters are passed in GenParamNameGenParamNameGenParamNameGenParamNamegenParamName, the corresponding configuration values are returned in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue. IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandle specifies the channels returned in open_io_channelopen_io_channelOpenIoChannelOpenIoChannelOpenIoChannel for a specific device instance.

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

Execution Information

Parameters

IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandle (input_control)  io_channel(-array) → HIOChannel, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handles of the opened I/O channels.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control)  string(-array) → HTupleHTupleHtuple (string) (string) (HString) (char*)

Parameter names.

Default value: '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"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (output_control)  string-array → HTupleHTupleHtuple (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_paramGetIoChannelParamGetIoChannelParamGetIoChannelParam 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_infoGetExtendedErrorInfoGetExtendedErrorInfoGetExtendedErrorInfo.

Possible Predecessors

open_io_channelopen_io_channelOpenIoChannelOpenIoChannelOpenIoChannel

Possible Successors

read_io_channelread_io_channelReadIoChannelReadIoChannelReadIoChannel, write_io_channelwrite_io_channelWriteIoChannelWriteIoChannelWriteIoChannel

See also

open_io_channelopen_io_channelOpenIoChannelOpenIoChannelOpenIoChannel, query_io_devicequery_io_deviceQueryIoDeviceQueryIoDeviceQueryIoDevice, set_io_channel_paramset_io_channel_paramSetIoChannelParamSetIoChannelParamSetIoChannelParam

Module

Foundation

ClassesClasses | | Operators
HALCON Operator Reference 18.05 Copyright © 1996-2018 MVTec Software GmbH