Class FingerprintDevice

Provides properties and methods to control and access fingerprint device finctionality. Use the FingerPrintDeviceManager class to discover and open instances of this class. Please note this class makes use of unmanaged resources. Dispose accordingly.

Inheritance

System.Object

FingerprintDevice

Implements

System.IDisposable

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 FingerprintDevice : IDisposable

Properties

DriverFullName

Gets the full name of the driver.

Declaration

public string DriverFullName { get; }

Property Value

Type	Description
System.String	The full name of the driver.

DriverName

Gets the name of the driver.

Declaration

public string DriverName { get; }

Property Value

Type	Description
System.String	The name of the driver.

EnrollStagesCount

Gets the enroll stages count for this device.

Declaration

public int EnrollStagesCount { get; protected set; }

Property Value

Type	Description
System.Int32	The enroll stages count.

ImageHeight

Gets or sets the height of the image.

Declaration

public int ImageHeight { get; protected set; }

Property Value

Type	Description
System.Int32	The height of the image.

ImageWidth

Gets or sets the width of the image.

Declaration

public int ImageWidth { get; protected set; }

Property Value

Type	Description
System.Int32	The width of the image.

IsOpen

Gets a value indicating whether this device is open and ready for operation.

Declaration

public bool IsOpen { get; }

Property Value

Type	Description
System.Boolean	true if this instance is open; otherwise, false.

SupportsIdentification

Gets or sets a value indicating whether this device supports identification.

Declaration

public bool SupportsIdentification { get; protected set; }

Property Value

Type	Description
System.Boolean	true if [supports identification]; otherwise, false.

SupportsImaging

Gets or sets a value indicating whether this device supports imaging.

Declaration

public bool SupportsImaging { get; protected set; }

Property Value

Type	Description
System.Boolean	true if [supports imaging]; otherwise, false.

SupportsVariableImagingDimensions

Gets or sets a value indicating whether this device supports variable imaging dimensions.

Declaration

public bool SupportsVariableImagingDimensions { get; protected set; }

Property Value

Type	Description
System.Boolean	true if [supports variable imaging dimensions]; otherwise, false.

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

Dispose(Boolean)

Releases unmanaged and - optionally - managed resources.

Declaration

protected virtual void Dispose(bool releaseOnlyManaged)

Parameters

Type	Name	Description
System.Boolean	releaseOnlyManaged	true to release both managed and unmanaged resources; false to release only unmanaged resources.

EnrollFingerprint()

Enrolls the fingerprint.

Declaration

public EnrollStageResult EnrollFingerprint()

Returns

Type	Description
EnrollStageResult

EnrollFingerprint(String)

Enrolls the fingerprint.

Declaration

public EnrollStageResult EnrollFingerprint(string pgmFilePath)

Parameters

Type	Name	Description
System.String	pgmFilePath	The PGM file path.

Returns

Type	Description
EnrollStageResult

Finalize()

Finalizes an instance of the FingerprintDeviceManager class.

Declaration

protected void Finalize()

IdentifyFingerprint(FingerprintGallery)

Identifies the fingerprint.

Declaration

public string IdentifyFingerprint(FingerprintGallery gallery)

Parameters

Type	Name	Description
FingerprintGallery	gallery	The gallery.

Returns

Type	Description
System.String

IdentifyFingerprint(FingerprintGallery, String)

Identifies the fingerprint.

Declaration

public string IdentifyFingerprint(FingerprintGallery gallery, string pgmFilePath)

Parameters

Type	Name	Description
FingerprintGallery	gallery	The gallery.
System.String	pgmFilePath	The PGM file path.

Returns

Type	Description
System.String

Open()

Opens this fingerprint scanning device. This method has to be called before operating the device

Declaration

public void Open()

Exceptions

Type	Condition
System.InvalidOperationException	Could not open device.

Reset()

Resets the device by closing and re-opening it.

Declaration

public void Reset()

VerifyFingerprint(String, FingerprintGallery)

Verifies the fingerprint.

Declaration

public bool VerifyFingerprint(string galleryKey, FingerprintGallery gallery)

Parameters

Type	Name	Description
System.String	galleryKey	The gallery key.
FingerprintGallery	gallery	The gallery.

Returns

Type	Description
System.Boolean

VerifyFingerprint(String, FingerprintGallery, String)

Verifies the fingerprint.

Declaration

public bool VerifyFingerprint(string galleryKey, FingerprintGallery gallery, string pgmFilePath)

Parameters

Type	Name	Description
System.String	galleryKey	The gallery key.
FingerprintGallery	gallery	The gallery.
System.String	pgmFilePath	The PGM file path.

Returns

Type	Description
System.Boolean

VerifyFingerprint(EnrollStageResult)

Verifies the fingerprint.

Declaration

public bool VerifyFingerprint(EnrollStageResult enrollResult)

Parameters

Type	Name	Description
EnrollStageResult	enrollResult	The enroll result.

Returns

Type	Description
System.Boolean

VerifyFingerprint(EnrollStageResult, String)

Verifies the fingerprint.

Declaration

public bool VerifyFingerprint(EnrollStageResult enrollResult, string pgmFilePath)

Parameters

Type	Name	Description
EnrollStageResult	enrollResult	The enroll result.
System.String	pgmFilePath	The PGM file path.

Returns

Type	Description
System.Boolean

Implements

System.IDisposable

Comments