ClassesClasses | | Operators

set_io_channel_paramT_set_io_channel_paramSetIoChannelParamSetIoChannelParam (Operator)

Name

set_io_channel_paramT_set_io_channel_paramSetIoChannelParamSetIoChannelParam — Set specific parameters of I/O channels.

Signature

set_io_channel_param( : : IOChannelHandle, GenParamName, GenParamValue : )

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

void SetIoChannelParam(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 HOperatorSet.SetIoChannelParam(HTuple IOChannelHandle, HTuple genParamName, HTuple genParamValue)

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

void HIOChannel.SetIoChannelParam(HTuple genParamName, HTuple genParamValue)

Description

set_io_channel_paramset_io_channel_paramSetIoChannelParamSetIoChannelParamSetIoChannelParam (re)configures the given transmission channels. The configuration parameters are passed in GenParamNameGenParamNameGenParamNameGenParamNamegenParamName, the corresponding values are passed in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue. IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandle specifies the transmission channels returned in open_io_channelopen_io_channelOpenIoChannelOpenIoChannelOpenIoChannel.

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

Execution Information

Parameters

IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandle (input_control)  io_channel(-array) HIOChannel, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Handles of the opened I/O channels.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control)  string-array HTupleHTupleHtuple (string) (string) (HString) (char*)

Parameter names.

Default value: []

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (input_control)  string-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_channel_paramset_io_channel_paramSetIoChannelParamSetIoChannelParamSetIoChannelParam 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_channelopen_io_channelOpenIoChannelOpenIoChannelOpenIoChannel

Possible Successors

read_io_channelread_io_channelReadIoChannelReadIoChannelReadIoChannel, write_io_channelwrite_io_channelWriteIoChannelWriteIoChannelWriteIoChannel

See also

open_io_channelopen_io_channelOpenIoChannelOpenIoChannelOpenIoChannel, query_io_devicequery_io_deviceQueryIoDeviceQueryIoDeviceQueryIoDevice, get_io_channel_paramget_io_channel_paramGetIoChannelParamGetIoChannelParamGetIoChannelParam, read_io_channelread_io_channelReadIoChannelReadIoChannelReadIoChannel, write_io_channelwrite_io_channelWriteIoChannelWriteIoChannelWriteIoChannel

Module

Foundation


ClassesClasses | | Operators