InkTools
Interface IFingerPrint

public interface IFingerPrint

This class describes the interface required for the use of the CicFingerPrint class. The MessageSink and StatusSink functions are called by the CicFingerPrint class in order to report asynchronous messages and status. For example, the EnrollFingerPrint method returns immediately, giving the host GUI the possibility to react on user interactions, while the MessageSink receives help messages guiding the user through the enrollment process. The enrollment process is then finally finished after the StatusSink receives the Status STATUS_ENROLL_OK or STATUS_ENROLL_FAILED. Only after the StatusSink received a final status, a previously started process like Enrollment or Verification have finished.

Version:

1.0

Author:

CIC

Field Summary

static int	STATUS_CANCELED Status: user canceled the last operation.
static int	STATUS_CAPTURE_FAILED Status: CaptureFingerPrint function failed.
static int	STATUS_CAPTURE_OK Status: CaptureFingerPrint function succeeded.
static int	STATUS_ENROLL_FAILED Status: EnrollFingerPrint function failed.
static int	STATUS_ENROLL_OK Status: EnrollFingerPrint function succeeded.
static int	STATUS_MATCH_FAILED Status: VerifyMatchFingerPrint function failed.
static int	STATUS_MATCH_OK Status: VerifyMatchFingerPrint function succeeded.
static int	STATUS_VERIFY_FAILED Status: VerifyFingerPrint function failed.
static int	STATUS_VERIFY_OK Status: VerifyFingerPrint function succeeded.

Method Summary

int	MessageSink(java.lang.String msg, int msgNum) This function gets called by the CicFingerPrint class to give users feedback about the capture, enrollment or verification process.
int	StatusSink(int status) This function receives the final status of the capture, enrollment and verification process.

Field Detail

STATUS_CAPTURE_OK

public static final int STATUS_CAPTURE_OK

Status: CaptureFingerPrint function succeeded.

See Also:

Constant Field Values

STATUS_CAPTURE_FAILED

public static final int STATUS_CAPTURE_FAILED

Status: CaptureFingerPrint function failed. Use GetLastErrorMsg() for further information.

See Also:

Constant Field Values

STATUS_ENROLL_OK

public static final int STATUS_ENROLL_OK

Status: EnrollFingerPrint function succeeded.

See Also:

Constant Field Values

STATUS_ENROLL_FAILED

public static final int STATUS_ENROLL_FAILED

Status: EnrollFingerPrint function failed. Use GetLastErrorMsg() for further information.

See Also:

Constant Field Values

STATUS_VERIFY_OK

public static final int STATUS_VERIFY_OK

Status: VerifyFingerPrint function succeeded.

See Also:

Constant Field Values

STATUS_VERIFY_FAILED

public static final int STATUS_VERIFY_FAILED

Status: VerifyFingerPrint function failed. Use GetLastErrorMsg() for further information.

See Also:

Constant Field Values

STATUS_MATCH_OK

public static final int STATUS_MATCH_OK

Status: VerifyMatchFingerPrint function succeeded.

See Also:

Constant Field Values

STATUS_MATCH_FAILED

public static final int STATUS_MATCH_FAILED

Status: VerifyMatchFingerPrint function failed. Use GetLastErrorMsg() for further information.

See Also:

Constant Field Values

STATUS_CANCELED

public static final int STATUS_CANCELED

Status: user canceled the last operation.

See Also:

Constant Field Values

Method Detail

MessageSink

public int MessageSink(java.lang.String msg,
                       int msgNum)

This function gets called by the CicFingerPrint class to give users feedback about the capture, enrollment or verification process.

Parameters:

msg - Message text to be displayed to the user.

msgNum - Number of the message text.

Returns:

StatusSink

public int StatusSink(int status)

This function receives the final status of the capture, enrollment and verification process. Actions depending on the result of the above functions, must be implemented here.

Parameters:

status - One of the provided STATUS_ codes.

Returns: