FingerScanner.getPreviewImage Method

Module: FingerScanner

Definition

Obtains the most recent preview image from the ongoing capture session.

Python

get_preview_image(self, picture: FingerImage) -> bool

Parameters

picture FingerImage

in The parameter to store the latest preview image.

Returns

bool

Indicates whether the preview image is available.

Exceptions

FingerCaptureException

An error has occurred during FingerCapture Library execution.

Dart

bool getPreviewImage(FingerImage picture)

Parameters

picture FingerImage

in The parameter to store the latest preview image.

Returns

bool

Indicates whether the preview image is available.

Exceptions

FingerCaptureException

An error has occurred during FingerCapture Library execution.

C#

public bool GetPreviewImage(FingerImage picture)

Parameters

picture FingerImage

in The parameter to store the latest preview image.

Returns

bool

Indicates whether the preview image is available.

Exceptions

FingerCaptureException

An error has occurred during FingerCapture Library execution.

C

int id3CaptureFingerScanner_GetPreviewImage (
    ID3_FINGER_CAPTURE_FINGER_SCANNER hFingerScanner,
    ID3_FINGER_IMAGE hPicture,
    bool * available)

Parameters

hFingerScanner ID3_FINGER_CAPTURE_FINGER_SCANNER

in Handle to the FingerScanner object.

hPicture ID3_FINGER_IMAGE

in The parameter to store the latest preview image.

available bool *

out Indicates whether the preview image is available.

Returns

int

An error code.

See id3FingerCaptureError file for the list of possible error codes.