DeviceChannel.getParameterValueInt Method

Module: DeviceChannel

Definition

Gets the integer value of a device parameter.

Python

get_parameter_value_int(self, parameter_name: str) -> int

Parameters

parameter_name str

in The parameter to query.

Returns

int

Outputs the integer value of the parameter.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Dart

int getParameterValueInt(String? parameterName)

Parameters

parameterName String

in The parameter to query.

Returns

int

Outputs the integer value of the parameter.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C#

public int GetParameterValueInt(string parameterName)

Parameters

parameterName string

in The parameter to query.

Returns

int

Outputs the integer value of the parameter.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Java

public int getParameterValueInt(String parameterName) throws DevicesException

Parameters

parameterName String

in The parameter to query.

Returns

int

Outputs the integer value of the parameter.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C

int id3DevicesDeviceChannel_GetParameterValueInt (
    ID3_DEVICES_DEVICE_CHANNEL hDeviceChannel,
    const char * parameterName,
    int * value)

Parameters

hDeviceChannel ID3_DEVICES_DEVICE_CHANNEL

in Handle to the DeviceChannel object.

parameterName const char *

in The parameter to query.

value int *

out Outputs the integer value of the parameter.

Returns

int

An error code.

See id3DevicesError file for the list of possible error codes.