Operator Reference

HALCON Operator Reference / System / I/O Devices

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

ClassesClasses | | Operators

set_io_device_paramT_set_io_device_paramSetIoDeviceParamSetIoDeviceParamset_io_device_param (Operator)

set_io_device_paramT_set_io_device_paramSetIoDeviceParamSetIoDeviceParamset_io_device_param — Configure a specific I/O device instance.

Signature

set_io_device_param( : : IODeviceHandle, GenParamName, GenParamValue : )

Herror T_set_io_device_param(const Htuple IODeviceHandle, const Htuple GenParamName, const Htuple GenParamValue)

void SetIoDeviceParam(const HTuple& IODeviceHandle, const HTuple& GenParamName, const HTuple& GenParamValue)

void HIODevice::SetIoDeviceParam(const HTuple& GenParamName, const HTuple& GenParamValue) const

void HIODevice::SetIoDeviceParam(const HString& GenParamName, const HString& GenParamValue) const

void HIODevice::SetIoDeviceParam(const char* GenParamName, const char* GenParamValue) const

void HIODevice::SetIoDeviceParam(const wchar_t* GenParamName, const wchar_t* GenParamValue) const   ( Windows only)

static void HOperatorSet.SetIoDeviceParam(HTuple IODeviceHandle, HTuple genParamName, HTuple genParamValue)

void HIODevice.SetIoDeviceParam(HTuple genParamName, HTuple genParamValue)

void HIODevice.SetIoDeviceParam(string genParamName, string genParamValue)

def set_io_device_param(iodevice_handle: HHandle, gen_param_name: MaybeSequence[str], gen_param_value: HTupleType) -> None

Description

set_io_device_paramset_io_device_paramSetIoDeviceParamSetIoDeviceParamset_io_device_param (re)configures a specific device instance. The configuration parameters are passed in GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name, the corresponding values are passed in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value. IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleiodevice_handle specifies the device specified 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: []

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control)  attribute.value(-array) → HTupleHTupleTypeHTupleHtuple (string / integer / real / handle) (string / int / long / double / HHandle) (HString / Hlong / double / HHandle) (char* / Hlong / double / handle)

Parameter values to set.

Default: []

Result

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

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, get_io_device_paramget_io_device_paramGetIoDeviceParamGetIoDeviceParamget_io_device_param

Module

Foundation

---

ClassesClasses | | Operators