set_io_channel_paramT_set_io_channel_paramSetIoChannelParamSetIoChannelParamset_io_channel_param (Operator)

Name

set_io_channel_paramT_set_io_channel_paramSetIoChannelParamSetIoChannelParamset_io_channel_param — Set specific parameters of I/O channels.

Signature

set_io_channel_param( : : IOChannelHandle, GenParamName, GenParamValue : )

Description

set_io_channel_paramset_io_channel_paramSetIoChannelParamSetIoChannelParamset_io_channel_param (re)configures the given transmission channels. The configuration parameters are passed in GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name, the corresponding values are passed in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value. IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleiochannel_handle specifies the transmission channels returned in open_io_channelopen_io_channelOpenIoChannelOpenIoChannelopen_io_channel.

Please check the directory 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

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

Handles of the opened I/O channels.

GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) string-array → (string)

Parameter names.

Default: []

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control) string-array → (string / integer / real / handle)

Parameter values to set.

Default: []

Result

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