Skip to content

set_io_device_paramSetIoDeviceParamSetIoDeviceParamset_io_device_paramT_set_io_device_param🔗

Short description🔗

set_io_device_paramSetIoDeviceParamSetIoDeviceParamset_io_device_paramT_set_io_device_param — Configure a specific I/O device instance.

Signature🔗

set_io_device_param( io_device IODeviceHandle, attribute.name GenParamName, attribute.value GenParamValue )void SetIoDeviceParam( const HTuple& IODeviceHandle, const HTuple& GenParamName, const HTuple& GenParamValue )static void HOperatorSet.SetIoDeviceParam( HTuple IODeviceHandle, HTuple genParamName, HTuple genParamValue )def set_io_device_param( iodevice_handle: HHandle, gen_param_name: MaybeSequence[str], gen_param_value: HTupleType ) -> None

Herror T_set_io_device_param( const Htuple IODeviceHandle, const Htuple GenParamName, const Htuple GenParamValue )

void HIODevice::SetIoDeviceParam( const HTuple& GenParamName, const HTuple& GenParamValue ) const

void HIODevice::SetIoDeviceParam( const HString& GenParamName, const HString& GenParamValue ) const

void HIODevice::SetIoDeviceParam( const char* GenParamName, const char* GenParamValue ) const

void HIODevice::SetIoDeviceParam( const wchar_t* GenParamName, const wchar_t* GenParamValue ) const (Windows only)

void HIODevice.SetIoDeviceParam( HTuple genParamName, HTuple genParamValue )

void HIODevice.SetIoDeviceParam( string genParamName, string genParamValue )

Description🔗

set_io_device_paramSetIoDeviceParam (re)configures a specific device instance. The configuration parameters are passed in GenParamNamegenParamNamegen_param_name, the corresponding values are passed in GenParamValuegenParamValuegen_param_value. IODeviceHandleIODeviceHandleiodevice_handle specifies the device specified in open_io_deviceOpenIoDevice.

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🔗

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🔗

IODeviceHandleIODeviceHandleiodevice_handle (input_control) io_device → (handle)HTuple (HHandle)HIODevice, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the opened I/O device.

GenParamNamegenParamNamegen_param_name (input_control) attribute.name(-array) → (string)HTuple (HString)HTuple (string)MaybeSequence[str]Htuple (char*)

Parameter names.

Default: [][]

GenParamValuegenParamValuegen_param_value (input_control) attribute.value(-array) → (string / integer / real / handle)HTuple (HString / Hlong / double / HHandle)HTuple (string / int / long / double / HHandle)HTupleTypeHtuple (char* / Hlong / double / handle)

Parameter values to set.

Default: [][]

Result🔗

If the parameters are valid, the operator set_io_device_paramSetIoDeviceParam 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_deviceOpenIoDevice

Possible successors

open_io_channelOpenIoChannel

See also

open_io_deviceOpenIoDevice, query_io_interfaceQueryIoInterface, get_io_device_paramGetIoDeviceParam

Module🔗

Foundation