FingerScanner.waitForCapture Method

Module: FingerScanner

Definition

Waits for a new capture to complete within a specified timeout.

wait_for_capture(self, timeout: int, do_event: bool) -> bool

Parameters

timeout int
in Maximum time to wait for a new capture, in milliseconds.

do_event bool
in Call doEvent() in the wait loop.

Returns

bool
Indicates whether a new capture is available.

Exceptions

FingerCaptureException
An error has occurred during FingerCapture Library execution.
bool waitForCapture(int timeout, bool doEvent)

Parameters

timeout int
in Maximum time to wait for a new capture, in milliseconds.

doEvent bool
in Call doEvent() in the wait loop.

Returns

bool
Indicates whether a new capture is available.

Exceptions

FingerCaptureException
An error has occurred during FingerCapture Library execution.
public bool WaitForCapture(int timeout, bool doEvent)

Parameters

timeout int
in Maximum time to wait for a new capture, in milliseconds.

doEvent bool
in Call doEvent() in the wait loop.

Returns

bool
Indicates whether a new capture is available.

Exceptions

FingerCaptureException
An error has occurred during FingerCapture Library execution.
int id3CaptureFingerScanner_WaitForCapture (
    ID3_FINGER_CAPTURE_FINGER_SCANNER hFingerScanner,
    int timeout,
    bool doEvent,
    bool * available)

Parameters

hFingerScanner ID3_FINGER_CAPTURE_FINGER_SCANNER
in Handle to the FingerScanner object.

timeout int
in Maximum time to wait for a new capture, in milliseconds.

doEvent bool
in Call doEvent() in the wait loop.

available bool *
out Indicates whether a new capture is available.

Returns

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