get_io_channel_paramT_get_io_channel_paramGetIoChannelParamGetIoChannelParamget_io_channel_param (Operator)
Name
get_io_channel_paramT_get_io_channel_paramGetIoChannelParamGetIoChannelParamget_io_channel_param — Query specific parameters of I/O channels.
Signature
Description
get_io_channel_paramget_io_channel_paramGetIoChannelParamGetIoChannelParamGetIoChannelParamget_io_channel_param queries settings of specific I/O
transmission channels. The query parameters are passed in
GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name, the corresponding configuration values are
returned in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value. IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleiochannel_handle specifies
the channels returned in open_io_channelopen_io_channelOpenIoChannelOpenIoChannelOpenIoChannelopen_io_channel for a specific
device instance.
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
IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleiochannel_handle (input_control) io_channel(-array) → HIOChannel, HTupleMaybeSequence[HHandle]HTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handles of the opened I/O channels.
GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) string(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Parameter names.
Default:
'param_name'
"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""io_channel_name", 'param_name'"param_name""param_name""param_name""param_name""param_name"
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (output_control) string-array → HTupleSequence[HTupleElementType]HTupleHtuple (string / integer / real / handle) (string / int / long / double / HHandle) (HString / Hlong / double / HHandle) (char* / Hlong / double / handle)
Parameter values.
Result
If the parameters are valid, the operator
get_io_channel_paramget_io_channel_paramGetIoChannelParamGetIoChannelParamGetIoChannelParamget_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_infoGetExtendedErrorInfoGetExtendedErrorInfoGetExtendedErrorInfoget_extended_error_info.
Possible Predecessors
open_io_channelopen_io_channelOpenIoChannelOpenIoChannelOpenIoChannelopen_io_channel
Possible Successors
read_io_channelread_io_channelReadIoChannelReadIoChannelReadIoChannelread_io_channel,
write_io_channelwrite_io_channelWriteIoChannelWriteIoChannelWriteIoChannelwrite_io_channel
See also
open_io_channelopen_io_channelOpenIoChannelOpenIoChannelOpenIoChannelopen_io_channel,
query_io_devicequery_io_deviceQueryIoDeviceQueryIoDeviceQueryIoDevicequery_io_device,
set_io_channel_paramset_io_channel_paramSetIoChannelParamSetIoChannelParamSetIoChannelParamset_io_channel_param
Module
Foundation