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

get_io_device_paramT_get_io_device_paramGetIoDeviceParamGetIoDeviceParam (Operator)

Name

get_io_device_paramT_get_io_device_paramGetIoDeviceParamGetIoDeviceParam — Query settings of an I/O device instance.

Signature

get_io_device_param( : : IODeviceHandle, GenParamName : GenParamValue)

Herror T_get_io_device_param(const Htuple IODeviceHandle, const Htuple GenParamName, Htuple* GenParamValue)

void GetIoDeviceParam(const HTuple& IODeviceHandle, const HTuple& GenParamName, HTuple* GenParamValue)

HTuple HIODevice::GetIoDeviceParam(const HTuple& GenParamName) const

HTuple HIODevice::GetIoDeviceParam(const HString& GenParamName) const

HTuple HIODevice::GetIoDeviceParam(const char* GenParamName) const

static void HOperatorSet.GetIoDeviceParam(HTuple IODeviceHandle, HTuple genParamName, out HTuple genParamValue)

HTuple HIODevice.GetIoDeviceParam(HTuple genParamName)

HTuple HIODevice.GetIoDeviceParam(string genParamName)

Description

get_io_device_paramget_io_device_paramGetIoDeviceParamGetIoDeviceParamGetIoDeviceParam queries configuration settings of a specific device instance. The query parameters are passed in GenParamNameGenParamNameGenParamNameGenParamNamegenParamName, the corresponding configuration values are returned in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue. IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandle specifies the device returned in open_io_deviceopen_io_deviceOpenIoDeviceOpenIoDeviceOpenIoDevice.

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 device specific parameters are listed.

Execution Information

Parameters

IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandle (input_control)  io_device → HIODevice, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the opened I/O device.

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

Parameter names.

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

Suggested values: 'io_device_name'"io_device_name""io_device_name""io_device_name""io_device_name", 'param_name'"param_name""param_name""param_name""param_name"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (output_control)  attribute.value(-array) → HTupleHTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)

Parameter values.

Result

If the parameters are valid, the operator get_io_device_paramget_io_device_paramGetIoDeviceParamGetIoDeviceParamGetIoDeviceParam 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_deviceopen_io_deviceOpenIoDeviceOpenIoDeviceOpenIoDevice, set_io_device_paramset_io_device_paramSetIoDeviceParamSetIoDeviceParamSetIoDeviceParam

Possible Successors

open_io_channelopen_io_channelOpenIoChannelOpenIoChannelOpenIoChannel

See also

open_io_deviceopen_io_deviceOpenIoDeviceOpenIoDeviceOpenIoDevice, query_io_interfacequery_io_interfaceQueryIoInterfaceQueryIoInterfaceQueryIoInterface, set_io_device_paramset_io_device_paramSetIoDeviceParamSetIoDeviceParamSetIoDeviceParam

Module

Foundation

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