C# Class zfm20.Zfm20Fingerprint

显示文件 Open project: dilshan/zfm20-lib Class Usage Examples

Public Methods

Method	Description
Capture ( ) : ZfmStatus	Send capture command to sensor module.
FreeFingerprintBuffer ( IntPtr &dataBuffer ) : ZfmStatus	Flush allocated fingerprint image buffer.
GetFingerprintBuffer ( IntPtr &dataBuffer, uint &dataBufferSize ) : ZfmStatus	Get content of sensor ImageBuffer as buffer.
IsAvailable ( ) : bool	Check availability of fingerprint sensor.
SaveFingerprintToFile ( string fileName ) : ZfmStatus	Save content of sensor's ImageBuffer to specified bitmap file.
Zfm20Fingerprint ( string portName, int baudRate ) : System	Constructor.

Private Methods

Method	Description
Zfm20CaptureFingerprint ( string comPort, Int32 baudRate, UInt32 sensorAddr ) : ZfmStatus
Zfm20FreeFingerprintBuffer ( IntPtr &dataBuffer ) : ZfmStatus
Zfm20GetFingerprintBuffer ( string comPort, Int32 baudRate, UInt32 sensorAddr, UInt32 &outBufferSize, IntPtr &outBuffer ) : ZfmStatus
Zfm20SaveFingerprintImage ( string comPort, Int32 baudRate, UInt32 sensorAddr, string fileName ) : ZfmStatus
Zfm20SensorAvailable ( string comPort, Int32 baudRate, UInt32 sensorAddr ) : ZfmStatus

Method Details

Capture() public method

Send capture command to sensor module.

public Capture ( ) : ZfmStatus
return	ZfmStatus

FreeFingerprintBuffer() public method

Flush allocated fingerprint image buffer.

public FreeFingerprintBuffer ( IntPtr &dataBuffer ) : ZfmStatus
dataBuffer	System.IntPtr	Data buffer to clean.
return	ZfmStatus

GetFingerprintBuffer() public method

Get content of sensor ImageBuffer as buffer.

public GetFingerprintBuffer ( IntPtr &dataBuffer, uint &dataBufferSize ) : ZfmStatus
dataBuffer	System.IntPtr	Data buffer which contain processed sensor ImageBuffer data.
dataBufferSize	uint	Size of the returned data buffer.
return	ZfmStatus

IsAvailable() public method

Check availability of fingerprint sensor.

public IsAvailable ( ) : bool
return	bool

SaveFingerprintToFile() public method

Save content of sensor's ImageBuffer to specified bitmap file.

public SaveFingerprintToFile ( string fileName ) : ZfmStatus
fileName	string	Filename to save sensor's ImageBuffer.
return	ZfmStatus

Zfm20Fingerprint() public method

Constructor.

public Zfm20Fingerprint ( string portName, int baudRate ) : System
portName	string	Communication port address or value.
baudRate	int	Communication port baud rate.
return	System