Operator Reference

HALCON Operator Reference / System / I/O Devices

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

ClassesClasses | | Operators

get_io_device_paramT_get_io_device_paramGetIoDeviceParamGetIoDeviceParamget_io_device_param (Operator)

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

HTuple HIODevice::GetIoDeviceParam(const wchar_t* GenParamName) const   ( Windows only)

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

HTuple HIODevice.GetIoDeviceParam(HTuple genParamName)

HTuple HIODevice.GetIoDeviceParam(string genParamName)

def get_io_device_param(iodevice_handle: HHandle, gen_param_name: MaybeSequence[str]) -> Sequence[HTupleElementType]

def get_io_device_param_s(iodevice_handle: HHandle, gen_param_name: MaybeSequence[str]) -> HTupleElementType

Description

get_io_device_paramget_io_device_paramGetIoDeviceParamGetIoDeviceParamget_io_device_param queries configuration settings of a specific device instance. The query parameters are passed in GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name, the corresponding configuration values are returned in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value. IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleiodevice_handle specifies the device returned in open_io_deviceopen_io_deviceOpenIoDeviceOpenIoDeviceopen_io_device.

Please check the directory doc/html/reference/io for documentation about your specific I/O device interface, where all supported device 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

IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleiodevice_handle (input_control)  io_device → HIODevice, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the opened I/O device.

GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  attribute.name(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Parameter names.

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

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (output_control)  attribute.value(-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_device_paramget_io_device_paramGetIoDeviceParamGetIoDeviceParamget_io_device_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_deviceopen_io_deviceOpenIoDeviceOpenIoDeviceopen_io_device, set_io_device_paramset_io_device_paramSetIoDeviceParamSetIoDeviceParamset_io_device_param

Possible Successors

open_io_channelopen_io_channelOpenIoChannelOpenIoChannelopen_io_channel

See also

open_io_deviceopen_io_deviceOpenIoDeviceOpenIoDeviceopen_io_device, query_io_interfacequery_io_interfaceQueryIoInterfaceQueryIoInterfacequery_io_interface, set_io_device_paramset_io_device_paramSetIoDeviceParamSetIoDeviceParamset_io_device_param

Module

Foundation

---

ClassesClasses | | Operators