set_io_device_paramT_set_io_device_paramSetIoDeviceParamSetIoDeviceParam (Operator)

Name

set_io_device_paramT_set_io_device_paramSetIoDeviceParamSetIoDeviceParam — Configure a specific I/O device instance.

Signature

set_io_device_param( : : IODeviceHandle, GenParamName, GenParamValue : )

Description

set_io_device_paramset_io_device_paramSetIoDeviceParamSetIoDeviceParamSetIoDeviceParam (re)configures a specific device instance. The configuration parameters are passed in GenParamNameGenParamNameGenParamNameGenParamNamegenParamName, the corresponding values are passed in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue. IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandle specifies the device specified 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

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandle (input_control) io_device → (handle)

Handle of the opened I/O device.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control) attribute.name(-array) → (string)

Parameter names.

Default value: []

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (input_control) attribute.value(-array) → (string / integer / real)

Parameter values to set.

Default value: []

Result

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