Class EnrollStageResult

Represents the state of a Fingerprint Enrollment operation

Inheritance
System.Object
EnrollStageResult
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Unosquare.Labs.LibFprint
Syntax
public class EnrollStageResult

Constructors

EnrollStageResult(Int32, Byte[])

Initializes a new instance of the EnrollStageResult class.

Declaration
public EnrollStageResult(int enrollCode, byte[] fingerprintData)
Parameters
Type Name Description
System.Int32 enrollCode

The enroll code.
System.Byte[] fingerprintData

The fingerprint data.

Properties

FingerprintData

Gets the buffer data holding the fingerprint scan. This is what needs to be saved in a database that will later be loased on to a FingerprintGallery object.

Declaration
public byte[] FingerprintData { get; protected set; }
Property Value
Type Description
System.Byte[]

The fingerprint data.

IsEnrollComplete

Gets a value indicating whether this instance represents an enrollment completion.

Declaration
public bool IsEnrollComplete { get; }
Property Value
Type Description
System.Boolean

true if this instance is enroll complete; otherwise, false.

IsEnrollFailure

Gets a value indicating whether this instance represents an enrollment failure.

Declaration
public bool IsEnrollFailure { get; }
Property Value
Type Description
System.Boolean

true if this instance is enroll failure; otherwise, false.

IsFatalError

Gets a value indicating whether the result contains a fatal error.

Declaration
public bool IsFatalError { get; }
Property Value
Type Description
System.Boolean

true if this instance is fatal error; otherwise, false.

IsSuccess

Gets a value indicating whether the result was a successful scan.

Declaration
public bool IsSuccess { get; }
Property Value
Type Description
System.Boolean

true if this instance is success; otherwise, false.

RequiresNewCall

Gets a value indicating whether a new call to the Enroll Fingerprint method is required to advance or to retry.

Declaration
public bool RequiresNewCall { get; }
Property Value
Type Description
System.Boolean

true if [requires new call]; otherwise, false.

RequiresRetry

Gets a value indicating whether the enrollment requires retry.

Declaration
public bool RequiresRetry { get; }
Property Value
Type Description
System.Boolean

true if [requires retry]; otherwise, false.

Result

Gets or sets the friendly result code.

Declaration
public EnrollResult Result { get; protected set; }
Property Value
Type Description
EnrollResult

The result.

ResultCode

Gets or sets the raw result code.

Declaration
public int ResultCode { get; protected set; }
Property Value
Type Description
System.Int32

The result code.

Comments