get_io_channel_paramT_get_io_channel_paramGetIoChannelParamGetIoChannelParam (Operator)

Name

get_io_channel_paramT_get_io_channel_paramGetIoChannelParamGetIoChannelParam — Query specific parameters of I/O channels.

Signature

get_io_channel_param( : : IOChannelHandle, GenParamName : GenParamValue)

Description

get_io_channel_paramget_io_channel_paramGetIoChannelParamGetIoChannelParamGetIoChannelParam queries settings of specific I/O transmission channels. The query parameters are passed in GenParamNameGenParamNameGenParamNameGenParamNamegenParamName, the corresponding configuration values are returned in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue. IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandle specifies the channels returned in open_io_channelopen_io_channelOpenIoChannelOpenIoChannelOpenIoChannel for a specific device instance.

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 channel-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

IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandle (input_control) io_channel(-array) → (handle)

Handles of the opened I/O channels.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control) string(-array) → (string)

Parameter names.

Default value: 'param_name' "param_name" "param_name" "param_name" "param_name"

Suggested values: 'io_channel_name'"io_channel_name""io_channel_name""io_channel_name""io_channel_name", 'param_name'"param_name""param_name""param_name""param_name"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (output_control) string-array → (string / integer / real / handle)

Parameter values.

Result

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