DeviceChannel.getParameterList Method

Module: DeviceChannel

Definition

Obtains all supported parameters, optionally filtered by category.

Python

get_parameter_list(self, category: str=None) -> DeviceParameterList

Parameters

category str

in Optional category to filter the parameters.

Returns

DeviceParameterList

Outputs the list of parameters.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Dart

DeviceParameterList getParameterList(String? category)

Parameters

category String

in Optional category to filter the parameters.

Returns

DeviceParameterList

Outputs the list of parameters.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C#

public DeviceParameterList GetParameterList(string category=null)

Parameters

category string

in Optional category to filter the parameters.

Returns

DeviceParameterList

Outputs the list of parameters.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Java

public DeviceParameterList getParameterList(String category) throws DevicesException

Parameters

category String

in Optional category to filter the parameters.

Returns

DeviceParameterList

Outputs the list of parameters.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C

int id3DevicesDeviceChannel_GetParameterList (
    ID3_DEVICES_DEVICE_CHANNEL hDeviceChannel,
    const char * category,
    ID3_DEVICES_DEVICE_PARAMETER_LIST hParameterList)

Parameters

hDeviceChannel ID3_DEVICES_DEVICE_CHANNEL

in Handle to the DeviceChannel object.

category const char *

in Optional category to filter the parameters.

hParameterList ID3_DEVICES_DEVICE_PARAMETER_LIST

out Outputs the list of parameters.

Returns

int

An error code.

See id3DevicesError file for the list of possible error codes.