DeviceChannel.setParameter Method

Module: DeviceChannel

Definition

Sets a device parameter’s value.

Python

set_parameter(self, parameter_name: str, data: DeviceParameter) -> None

Parameters

parameter_name str

in The parameter to set.

data DeviceParameter

in The value to set the parameter to.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Dart

void setParameter(String? parameterName, DeviceParameter data)

Parameters

parameterName String

in The parameter to set.

data DeviceParameter

in The value to set the parameter to.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C#

public void SetParameter(string parameterName, DeviceParameter data)

Parameters

parameterName string

in The parameter to set.

data DeviceParameter

in The value to set the parameter to.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Java

public void setParameter(String parameterName, DeviceParameter data) throws DevicesException

Parameters

parameterName String

in The parameter to set.

data DeviceParameter

in The value to set the parameter to.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C

int id3DevicesDeviceChannel_SetParameter (
    ID3_DEVICES_DEVICE_CHANNEL hDeviceChannel,
    const char * parameterName,
    ID3_DEVICES_DEVICE_PARAMETER hData)

Parameters

hDeviceChannel ID3_DEVICES_DEVICE_CHANNEL

in Handle to the DeviceChannel object.

parameterName const char *

in The parameter to set.

hData ID3_DEVICES_DEVICE_PARAMETER

in The value to set the parameter to.

Returns

int

An error code.

See id3DevicesError file for the list of possible error codes.