set_io_device_paramT_set_io_device_paramSetIoDeviceParamSetIoDeviceParam (Operator)

Name

set_io_device_paramT_set_io_device_paramSetIoDeviceParamSetIoDeviceParam — Configure a specific I/O device instance.

Signature

set_io_device_param( : : IODeviceHandle, GenParamName, GenParamValue : )

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

void SetIoDeviceParam(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)

static void HOperatorSet.SetIoDeviceParam(HTuple IODeviceHandle, HTuple genParamName, HTuple genParamValue)

void HIODevice.SetIoDeviceParam(HTuple genParamName, HTuple genParamValue)

void HIODevice.SetIoDeviceParam(string genParamName, string genParamValue)

Description

set_io_device_paramset_io_device_paramSetIoDeviceParamSetIoDeviceParamSetIoDeviceParam (re)configures a specific device instance. The configuration parameters are passed in GenParamNameGenParamNameGenParamNameGenParamNamegenParamName, the corresponding values are passed in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue. IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandle specifies the device specified in open_io_deviceopen_io_deviceOpenIoDeviceOpenIoDeviceOpenIoDevice.

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 device specific parameters are listed.

Execution Information

Parameters

IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandle (input_control)  io_device HIODevice, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the opened I/O device.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control)  attribute.name(-array) HTupleHTupleHtuple (string) (string) (HString) (char*)

Parameter names.

Default value: []

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (input_control)  attribute.value(-array) HTupleHTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)

Parameter values to set.

Default value: []

Result

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

Possible Predecessors

open_io_deviceopen_io_deviceOpenIoDeviceOpenIoDeviceOpenIoDevice

Possible Successors

open_io_channelopen_io_channelOpenIoChannelOpenIoChannelOpenIoChannel

See also

open_io_deviceopen_io_deviceOpenIoDeviceOpenIoDeviceOpenIoDevice, query_io_interfacequery_io_interfaceQueryIoInterfaceQueryIoInterfaceQueryIoInterface, get_io_device_paramget_io_device_paramGetIoDeviceParamGetIoDeviceParamGetIoDeviceParam

Module

Foundation