DeviceChannel.getParameterDescriptor Method

Module: DeviceChannel

Definition

Fetches the descriptor of a device parameter.

get_parameter_descriptor(self, parameter_name: str) -> DeviceParameterDescriptor

Parameters

parameter_name str
in The name of the parameter.

Returns

Outputs the parameter’s descriptor.

Exceptions

An error has occurred during Devices Library execution.
DeviceParameterDescriptor getParameterDescriptor(String? parameterName)

Parameters

parameterName String
in The name of the parameter.

Returns

Outputs the parameter’s descriptor.

Exceptions

An error has occurred during Devices Library execution.
public DeviceParameterDescriptor GetParameterDescriptor(string parameterName)

Parameters

parameterName string
in The name of the parameter.

Returns

Outputs the parameter’s descriptor.

Exceptions

An error has occurred during Devices Library execution.
public DeviceParameterDescriptor getParameterDescriptor(String parameterName) throws DevicesException

Parameters

parameterName String
in The name of the parameter.

Returns

Outputs the parameter’s descriptor.

Exceptions

An error has occurred during Devices Library execution.
int id3DevicesDeviceChannel_GetParameterDescriptor (
    ID3_DEVICES_DEVICE_CHANNEL hDeviceChannel,
    const char * parameterName,
    ID3_DEVICES_DEVICE_PARAMETER_DESCRIPTOR hDescriptor)

Parameters

in Handle to the DeviceChannel object.

parameterName const char *
in The name of the parameter.

out Outputs the parameter’s descriptor.

Returns

int
An error code.
See id3DevicesError file for the list of possible error codes.