FingerScanner.getParameterDescriptor Method¶

Definition¶

Fetches the descriptor of a device parameter.

Python

get_parameter_descriptor(self, parameter_name: str) -> DeviceParameterDescriptor

Parameters

parameter_name str

in The name of the parameter.

Returns

DeviceParameterDescriptor

Outputs the parameter’s descriptor.

Exceptions

FingerCaptureException

An error has occurred during FingerCapture Library execution.

Dart

DeviceParameterDescriptor getParameterDescriptor(String? parameterName)

Parameters

parameterName String

in The name of the parameter.

Returns

DeviceParameterDescriptor

Outputs the parameter’s descriptor.

Exceptions

FingerCaptureException

An error has occurred during FingerCapture Library execution.

public DeviceParameterDescriptor GetParameterDescriptor(string parameterName)

Parameters

parameterName string

in The name of the parameter.

Returns

DeviceParameterDescriptor

Outputs the parameter’s descriptor.

Exceptions

FingerCaptureException

An error has occurred during FingerCapture Library execution.

int id3CaptureFingerScanner_GetParameterDescriptor (
    ID3_FINGER_CAPTURE_FINGER_SCANNER hFingerScanner,
    const char * parameterName,
    ID3_DEVICES_DEVICE_PARAMETER_DESCRIPTOR hDescriptor)

Parameters

hFingerScanner ID3_FINGER_CAPTURE_FINGER_SCANNER

in Handle to the FingerScanner object.

parameterName const char *

in The name of the parameter.

hDescriptor ID3_DEVICES_DEVICE_PARAMETER_DESCRIPTOR

out Outputs the parameter’s descriptor.

Returns

int

An error code.

See id3FingerCaptureError file for the list of possible error codes.