Skip to content

set_io_channel_paramSetIoChannelParamSetIoChannelParamset_io_channel_paramT_set_io_channel_param🔗

Short description🔗

set_io_channel_paramSetIoChannelParamSetIoChannelParamset_io_channel_paramT_set_io_channel_param — Set specific parameters of I/O channels.

Signature🔗

set_io_channel_param( io_channel IOChannelHandle, string GenParamName, string GenParamValue )void SetIoChannelParam( const HTuple& IOChannelHandle, const HTuple& GenParamName, const HTuple& GenParamValue )static void HOperatorSet.SetIoChannelParam( HTuple IOChannelHandle, HTuple genParamName, HTuple genParamValue )def set_io_channel_param( iochannel_handle: MaybeSequence[HHandle], gen_param_name: Sequence[str], gen_param_value: Sequence[HTupleElementType] ) -> None

Herror T_set_io_channel_param( const Htuple IOChannelHandle, const Htuple GenParamName, const Htuple GenParamValue )

static void HIOChannel::SetIoChannelParam( const HIOChannelArray& IOChannelHandle, const HTuple& GenParamName, const HTuple& GenParamValue )

void HIOChannel::SetIoChannelParam( const HTuple& GenParamName, const HTuple& GenParamValue ) const

static void HIOChannel.SetIoChannelParam( HIOChannel[] IOChannelHandle, HTuple genParamName, HTuple genParamValue )

void HIOChannel.SetIoChannelParam( HTuple genParamName, HTuple genParamValue )

Description🔗

set_io_channel_paramSetIoChannelParam (re)configures the given transmission channels. The configuration parameters are passed in GenParamNamegenParamNamegen_param_name, the corresponding values are passed in GenParamValuegenParamValuegen_param_value. IOChannelHandleIOChannelHandleiochannel_handle specifies the transmission channels returned in open_io_channelOpenIoChannel.

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🔗

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🔗

IOChannelHandleIOChannelHandleiochannel_handle (input_control) io_channel(-array) → (handle)HTuple (HHandle)HIOChannel, HTuple (IntPtr)MaybeSequence[HHandle]Htuple (handle)

Handles of the opened I/O channels.

GenParamNamegenParamNamegen_param_name (input_control) string-array → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)

Parameter names.

Default: [][]

GenParamValuegenParamValuegen_param_value (input_control) string-array → (string / integer / real / handle)HTuple (HString / Hlong / double / HHandle)HTuple (string / int / long / double / HHandle)Sequence[HTupleElementType]Htuple (char* / Hlong / double / handle)

Parameter values to set.

Default: [][]

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

open_io_channelOpenIoChannel

Possible successors

read_io_channelReadIoChannel, write_io_channelWriteIoChannel

See also

open_io_channelOpenIoChannel, query_io_deviceQueryIoDevice, get_io_channel_paramGetIoChannelParam, read_io_channelReadIoChannel, write_io_channelWriteIoChannel

Module🔗

Foundation