get_io_device_paramT_get_io_device_paramGetIoDeviceParamGetIoDeviceParamget_io_device_param (Operator)

Name

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)

Description

get_io_device_paramget_io_device_paramGetIoDeviceParamGetIoDeviceParamGetIoDeviceParamget_io_device_param queries configuration settings of a specific device instance. The query parameters are passed in GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name, the corresponding configuration values are returned in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value. IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleiodevice_handle specifies the device returned in open_io_deviceopen_io_deviceOpenIoDeviceOpenIoDeviceOpenIoDeviceopen_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

IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleiodevice_handle (input_control) io_device → (handle)

Handle of the opened I/O device.

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

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"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (output_control) attribute.value(-array) → (string / integer / real)

Parameter values.

Result

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