DeviceChannel.checkParameter Method

Module: DeviceChannel

Definition

Confirms if a parameter exists on the device.

Python

check_parameter(self, parameter_name: str) -> bool

Parameters

parameter_name str

in The name of the parameter to check.

Returns

bool

Outputs true if the parameter exists.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Dart

bool checkParameter(String? parameterName)

Parameters

parameterName String

in The name of the parameter to check.

Returns

bool

Outputs true if the parameter exists.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C#

public bool CheckParameter(string parameterName)

Parameters

parameterName string

in The name of the parameter to check.

Returns

bool

Outputs true if the parameter exists.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Java

public boolean checkParameter(String parameterName) throws DevicesException

Parameters

parameterName String

in The name of the parameter to check.

Returns

boolean

Outputs true if the parameter exists.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C

int id3DevicesDeviceChannel_CheckParameter (
    ID3_DEVICES_DEVICE_CHANNEL hDeviceChannel,
    const char * parameterName,
    bool * result)

Parameters

hDeviceChannel ID3_DEVICES_DEVICE_CHANNEL

in Handle to the DeviceChannel object.

parameterName const char *

in The name of the parameter to check.

result bool *

out Outputs true if the parameter exists.

Returns

int

An error code.

See id3DevicesError file for the list of possible error codes.