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

get_io_device_paramget_io_device_paramGetIoDeviceParamget_io_device_paramGetIoDeviceParamGetIoDeviceParam (Operator)

Name

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

Signature

get_io_device_param( : : IODeviceHandle, ParamName : ParamValue)

Herror get_io_device_param(const Hlong IODeviceHandle, const char* ParamName, char* ParamValue)

Herror T_get_io_device_param(const Htuple IODeviceHandle, const Htuple ParamName, Htuple* ParamValue)

Herror get_io_device_param(const HTuple& IODeviceHandle, const HTuple& ParamName, char* ParamValue)

Herror get_io_device_param(const HTuple& IODeviceHandle, const HTuple& ParamName, HTuple* ParamValue)

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

void GetIoDeviceParam(const HTuple& IODeviceHandle, const HTuple& ParamName, HTuple* ParamValue)

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

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

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

void HOperatorSetX.GetIoDeviceParam(
[in] VARIANT IODeviceHandle, [in] VARIANT ParamName, [out] VARIANT* ParamValue)

VARIANT HIODeviceX.GetIoDeviceParam([in] VARIANT ParamName)

static void HOperatorSet.GetIoDeviceParam(HTuple IODeviceHandle, HTuple paramName, out HTuple paramValue)

HTuple HIODevice.GetIoDeviceParam(HTuple paramName)

HTuple HIODevice.GetIoDeviceParam(string paramName)

Description

get_io_device_paramget_io_device_paramGetIoDeviceParamget_io_device_paramGetIoDeviceParamGetIoDeviceParam queries configuration settings of a specific device instance. The query parameters are passed in ParamNameParamNameParamNameParamNameParamNameparamName, the corresponding configuration values are returned in ParamValueParamValueParamValueParamValueParamValueparamValue. IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandle specifies the device returned in open_io_deviceopen_io_deviceOpenIoDeviceopen_io_deviceOpenIoDeviceOpenIoDevice.

Please check the directory 'doc/html/reference/io'"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.

Parallelization

Parameters

IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandle (input_control)  io_device → HIODevice, HTupleHTupleHIODevice, HTupleHIODeviceX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the opened I/O device.

ParamNameParamNameParamNameParamNameParamNameparamName (input_control)  attribute.name(-array) → HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Parameter names.

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

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

Parameter values.

Result

If the parameters are valid, the operator get_io_device_paramget_io_device_paramGetIoDeviceParamget_io_device_paramGetIoDeviceParamGetIoDeviceParam 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_infoGetExtendedErrorInfoget_extended_error_infoGetExtendedErrorInfoGetExtendedErrorInfo.

Possible Predecessors

open_io_deviceopen_io_deviceOpenIoDeviceopen_io_deviceOpenIoDeviceOpenIoDevice, set_io_device_paramset_io_device_paramSetIoDeviceParamset_io_device_paramSetIoDeviceParamSetIoDeviceParam

Possible Successors

open_io_channelopen_io_channelOpenIoChannelopen_io_channelOpenIoChannelOpenIoChannel

See also

open_io_deviceopen_io_deviceOpenIoDeviceopen_io_deviceOpenIoDeviceOpenIoDevice, query_io_interfacequery_io_interfaceQueryIoInterfacequery_io_interfaceQueryIoInterfaceQueryIoInterface, set_io_device_paramset_io_device_paramSetIoDeviceParamset_io_device_paramSetIoDeviceParamSetIoDeviceParam

Module

Foundation

ClassesClassesClassesClasses | | | | Operators
HALCON Operator Reference 12.0.2 Copyright © 1996-2016 MVTec Software GmbH