This is an old revision of the document!

Fingerprint API > BS2_ScanFingerprint

BS2_ScanFingerprint

Scans a fingerprint from a device and extracts template data.

Declaration

#include "BS_API.h"
 
int BS2_ScanFingerprint(void* context, uint32_t deviceId, BS2Fingerprint* finger, uint32_t templateIndex, uint32_t quality, uint8_t templateFormat, OnReadyToScan ptrReadyToScan);
See BS2Fingerprint Structure

Parameter

  • [In] context : Context
  • [In] deviceId : Device ID
  • [Out] finger : Pointer to store the template data
  • [In] templateIndex : Template data index
  • [In] quality : Required quality of fingerprint template
  • [In] templateFormat : Format of the template
  • [Out] ptrReadyToScan : Callback function that is called when it's ready to scan a fingerprint

Return Value

If successfully done, BS_SDK_SUCCESS will be returned.
If there is an error, the corresponding error code will be returned.

See Also

BS2_VerifyFingerprint