DigitalPersona, Inc.

One Touch® for Windows® SDK

COM/ActiveX® Edition
Version 1.3

Developer Guide
DigitalPersona, Inc.
© 1996–2008 DigitalPersona, Inc. All Rights Reserved.
All intellectual property rights in the DigitalPersona software, firmware, hardware, and documentation included with or
described in this guide are owned by DigitalPersona or its suppliers and are protected by United States copyright laws,
other applicable copyright laws, and international treaty provisions. DigitalPersona and its suppliers retain all rights not
expressly granted.
DigitalPersona, U.are.U, and One Touch are trademarks of DigitalPersona, Inc., registered in the United States and other
countries. Adobe and Adobe Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in the
United States and/or other countries. Microsoft, Visual C++, Visual Studio, Windows, Windows Server, and Windows Vista
are registered trademarks of Microsoft Corporation in the United States and other countries.
This guide and the software it describes are furnished under license as set forth in the “License Agreement” that is shown
during the installation process.
Except as permitted by such license or by the terms of this guide, no part of this document may be reproduced, stored,
transmitted, and translated, in any form and by any means, without the prior written consent of DigitalPersona. The
contents of this guide are furnished for informational use only and are subject to change without notice. Any mention of
third-party companies and products is for demonstration purposes only and constitutes neither an endorsement nor a
recommendation. DigitalPersona assumes no responsibility with regard to the performance or use of these third-party
products. DigitalPersona makes every effort to ensure the accuracy of its documentation and assumes no responsibility or
liability for any errors or inaccuracies that may appear in it.

Technical Support
Upon your purchase of a Developer Support package (available from http://buy.digitalpersona.com), you are entitled to a
specified number of hours of telephone and email support.

Feedback
Although the information in this guide has been thoroughly reviewed and tested, we welcome your feedback on any
errors, omissions, or suggestions for future improvements. Please contact us at
[email protected]
or
DigitalPersona, Inc.
720 Bay Road, Suite 100
Redwood City, California 94063
USA
(650) 474-4000
(650) 298-8313 Fax

Document Publication Date: June 13, 2008008

Table of Contents

1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Target Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Chapter Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Notational Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Naming Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Additional Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Online Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Supported DigitalPersona Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Fingerprint Template Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2 Quick Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Quick Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Install the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Insert the Fingerprint Reader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Using the Sample Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

3 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Installing the SDK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Installing the Runtime Environment (RTE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Installing and Uninstalling the RTE Silently . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

4 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Biometric System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Fingerprint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Fingerprint Recognition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Fingerprint Enrollment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Fingerprint Verification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
False Positives and False Negatives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Fingerprint Enrollment Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Fingerprint Enrollment with UI Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Fingerprint Verification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Fingerprint Verification with UI Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Fingerprint Data Object Serialization/Deserialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide iii
Table of Contents

5 API Reference for Visual Basic Developers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Component Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
DPFPCapture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
StartCapture Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
StopCapture Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Priority Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
ReaderSerialNumber Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
OnComplete Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
OnFingerGone Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
OnFingerTouch Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
OnReaderConnect Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
OnReaderDisconnect Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
OnSampleQuality Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
DPFPData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Deserialize Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Serialize Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
DPFPEnrollment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
AddFeatures Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Clear Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
FeaturesNeeded Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Template Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
TemplateStatus Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
DPFPEnrollmentControl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
EnrolledFingersMask Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
MaxEnrollFingerCount Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
ReaderSerialNumber Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
OnDelete Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
OnEnroll Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
DPFPEventHandlerStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Status Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
DPFPFeatureExtraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
CreateFeatureSet Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
FeatureSet Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
DPFPFeatureSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Deserialize Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Serialize Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
DPFPReaderDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
FirmwareRevision Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
HardwareRevision Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Language Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide iv
Table of Contents

ImpressionType Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
ProductName Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
SerialNumber Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
SerialNumberType Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Technology Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Vendor Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
DPFPReadersCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Reader Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Count Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Item Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
_NewEnum Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
DPFPSample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Deserialize Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Serialize Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
DPFPSampleConversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
ConvertToANSI381 Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
ConvertToPicture Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
DPFPTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Deserialize Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Serialize Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
DPFPVerification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Verify Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
FARRequested Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
DPFPVerificationControl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
ReaderSerialNumber Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
OnComplete Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
DPFPVerificationResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
FARAchieved Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Verified Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Enumerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
DPFPCaptureFeedbackEnum Enumeration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
DPFPCapturePriorityEnum Enumeration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
DPFPEventHandlerStatusEnum Enumeration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
DPFPDataPurposeEnum Enumeration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
DPFPReaderImpressionTypeEnum Enumeration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
DPFPReaderTechnologyEnum Enumeration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
DPFPSerialNumberTypeEnum Enumeration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
DPFPTemplateStatusEnum Enumeration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide v
Table of Contents

6 API Reference for C++ Developers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
IDPFPCapture Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
IDPFPCapture::Priority Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
IDPFPCapture::ReaderSerialNumber Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
IDPFPCapture::StartCapture Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
IDPFPCapture::StopCapture Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
_IDPFPCaptureEvents Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
_IDPFPCaptureEvents::OnComplete Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
_IDPFPCaptureEvents::OnFingerGone Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
_IDPFPCaptureEvents::OnFingerTouch Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
_IDPFPCaptureEvents::OnReaderConnect Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
_IDPFPCaptureEvents::OnReaderDisconnect Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
_IDPFPCaptureEvents::OnSampleQuality Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
IDPFPData Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
IDPFPData::Deserialize Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
IDPFPData::Serialize Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
IDPFPEnrollment Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
IDPFPEnrollment::AddFeatures Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
IDPFPEnrollment::Clear Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
IDPFPEnrollment::FeaturesNeeded Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
IDPFPEnrollment::Template Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
IDPFPEnrollment::TemplateStatus Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
IDPFPEnrollmentControl Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
IDPFPEnrollmentControl::EnrolledFingersMask Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
IDPFPEnrollmentControl::MaxEnrollFingerCount Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
IDPFPEnrollmentControl::ReaderSerialNumber Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
_IDPFPEnrollmentControlEvents Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
_IDPFPEnrollmentControlEvents::OnDelete Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
_IDPFPEnrollmentControlEvents::OnEnroll Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
IDPFPEventHandlerStatus Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
IDPFPEventHandlerStatus::Status Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
IDPFPFeatureExtraction Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
IDPFPFeatureExtraction::CreateFeatureSet Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
IDPFPFeatureExtraction::FeatureSet Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
IDPFPFeatureSet Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
IDPFPFeatureSet::Deserialize Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
IDPFPFeatureSet::Serialize Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
IDPFPReaderDescription Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
IDPFPReaderDescription::FirmwareRevision Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide vi
Table of Contents

IDPFPReaderDescription::HardwareRevision Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
IDPFPReaderDescription::Language Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
IDPFPReaderDescription::ImpressionType Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
IDPFPReaderDescription::ProductName Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
IDPFPReaderDescription::SerialNumber Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
IDPFPReaderDescription::SerialNumberType Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
IDPFPReaderDescription::Technology Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
IDPFPReaderDescription::Vendor Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
IDPFPReadersCollection Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
IDPFPReadersCollection::Reader Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
IDPFPReadersCollection::Count Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
IDPFPReadersCollection::Item Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
IDPFPReadersCollection::_NewEnum Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
IDPFPSample Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
IDPFPSample::Deserialize Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
IDPFPSample::Serialize Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
IDPFPSampleConversion Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
IDPFPSample::ConvertToANSI381 Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
IDPFPSample::ConvertToPicture Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
IDPFPTemplate Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
IDPFPTemplate::Deserialize Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
IDPFPTemplate::Serialize Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
IDPFPVerification Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
IDPFPVerification::FARRequested Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
IDPFPVerification::Verify Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
IDPFPVerificationControl Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
IDPFPVerificationControl::ReaderSerialNumber Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
_IDPFPVerificationControlEvents Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
_IDPFPVerificationControlEvents::OnComplete Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
IDPFPVerificationResult Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
IDPFPVerificationResult::FARAchieved Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
IDPFPVerificationResult::Verified Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Enumerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
DPFPCaptureFeedbackEnum Enumerated Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
DPFPCapturePriorityEnum Enumerated Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
DPFPEventHandlerStatusEnum Enumerated Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
DPFPDataPurposeEnum Enumerated Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
DPFPReaderImpressionTypeEnum Enumerated Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
DPFPReaderTechnologyEnum Enumerated Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
DPFPSerialNumberTypeEnum Enumerated Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide vii
Table of Contents

DPFPTemplateStatusEnum Enumerated Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

7 User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

DPFPEnrollmentControl Object User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Enrolling a Fingerprint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Deleting a Fingerprint Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
DPFPVerificationControl Object User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

8 Developing Citrix-aware applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

9 Redistribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
RTE\Install Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Redist Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Fingerprint Reader Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Hardware Warnings and Regulatory Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Fingerprint Reader Use and Maintenance Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

A Setting the False Accept Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

False Accept Rate (FAR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Representation of Probability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Requested FAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Specifying the FAR in Visual Basic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Specifying the FAR in C++ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Achieved FAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

B Platinum SDK Registration Template Conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

Platinum SDK Registration Template Conversion for Microsoft Visual C++ Applications . . . . . . . . . . . . 135
Platinum SDK Registration Template Conversion for Visual Basic 6.0 Applications . . . . . . . . . . . . . . . . . 137

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide viii
Introduction 1

The One Touch® for Windows SDK is a software development tool that enables developers to integrate
fingerprint biometrics into a wide set of Microsoft® Windows®-based applications, services, and products. The
tool enables developers to perform basic fingerprint biometric operations: capturing a fingerprint from a
DigitalPersona fingerprint reader, extracting the distinctive features from the captured fingerprint sample, and
storing the resulting data in a template for later comparison of a submitted fingerprint with an existing
fingerprint template.

In addition, the One Touch for Windows SDK enables developers to use a variety of programming languages in
a number of development environments to create their applications. The product includes detailed
documentation and sample code that can be used to guide developers to quickly and efficiently produce
fingerprint biometric additions to their products.

The One Touch for Windows SDK builds on a decade-long legacy of fingerprint biometric technology, being
the most popular set of development tools with the largest set of enrolled users of any biometric product in the
world. Because of its popularity, the DigitalPersona® Fingerprint Recognition Engine software —with its high
level of accuracy—and award-winning U.are.U® Fingerprint Reader hardware have been used with the widest-
age, hardest-to-fingerprint demographic of users in the world.

The One Touch for Windows SDK has been designed to authenticate users on the Microsoft® Windows Vista®
and Microsoft® Windows® XP operating systems running on any of the x86-based platforms. The product is
used with DigitalPersona fingerprint readers in a variety of useful configurations: standalone USB peripherals,
modules that are built into customer platforms, and keyboards. The DigitalPersona One Touch I.D. SDK product
can also be implemented along with the One Touch for Windows SDK product to add fast fingerprint
identification capability to a developer’s design.

Fingerprint Authentication on a Remote Computer

This SDK includes transparent support for fingerprint authentication through Windows Terminal Services
(including Remote Desktop Connection) and through a Citrix connection to Metaframe Presentation Server
using a client from the Citrix Presentation Server Client package.

Through Remote Desktop or a Citrix session, you can use a local fingerprint reader to log on to, and use other
installed features of, a remote machine running your fingerprint-enabled application.

The following types of Citrix clients are supported:

„ • Program Neighborhood
„ • Program Neighborhood Agent
„ • Web Client
Note that to take advantage of this feature, your fingerprint-enabled application must run on the Terminal
Services or Citrix server, not on the client. If you are developing a Citrix-aware application, see additional
information in the Developing Citrix-aware applications chapter on page 126.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 1
Chapter 1: Introduction Target Audience

Target Audience
This guide is for developers who have a working knowledge of the C++ or Microsoft® Visual Basic®
programming language and the RPC paradigm as it applies to COM, or familiarity with OLE Automation model
scripting and type libraries.

Chapter Overview
Chapter 1, Introduction (this chapter), describes the audience for which this guide is written; defines the
typographical, notational, and naming conventions used throughout this guide; cites a number of resources
that may assist you in using the One Touch for Windows SDK: COM/ActiveX Edition; identifies the minimum
system requirements needed to run the One Touch for Windows SDK: COM/ActiveX Edition; and lists the
DigitalPersona products and fingerprint templates supported by the One Touch for Windows SDK: COM/
ActiveX Edition.

Chapter 2, Quick Start, provides a quick introduction to the One Touch for Windows SDK: COM/ActiveX Edition
using one of the sample applications provided as part of the SDK.

Chapter 3, Installation, contains instructions for installing the various components of the product and identifies
the files and folders that are installed on your hard disk.

Chapter 4, Overview, introduces One Touch for Windows SDK: COM/ActiveX Edition terminology and concepts.
This chapter also includes typical workflow diagrams and explanations of the One Touch for Windows: COM/
ActiveX Edition API functions used to perform the tasks in the workflows.

Chapter 5, API Reference for Visual Basic Developers, defines the API components that are used for developing
applications based on the One Touch for Windows: COM/ActiveX Edition API in Microsoft® Visual Basic®.

Chapter 6, API Reference for C++ Developers, defines the API components that are used for developing
applications based on the One Touch for Windows: COM/ActiveX Edition API in C++.

Chapter 7, User Interface, describes the functionality of the user interfaces included with the fingerprint
enrollment and fingerprint verification ActiveX controls.

Chapter 9, Redistribution, identifies the files that you may distribute according to the End User License
Agreement (EULA) and lists the functionalities that you need to provide to your end users when you develop
products based on the One Touch for Windows: COM/ActiveX Edition API.

Appendix A, Setting the False Accept Rate, provides information about determining and using specific values for
the FAR and evaluating and testing achieved values.

Appendix B, Platinum SDK Registration Template Conversion, contains sample code for converting Platinum SDK
registration templates for use with the One Touch for Windows SDK: COM/ActiveX Edition.

A glossary and an index are also included for your reference.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 2
Chapter 1: Introduction Document Conventions

Document Conventions
This section defines the notational, typographical, and naming conventions used in this guide.

Notational Conventions
The following notational conventions are used throughout this guide:

NOTE: Notes provide supplemental reminders, tips, or suggestions.

IMPORTANT: Important notations contain significant information about system behavior, including problems
or side effects that can occur in specific situations.

Typographical Conventions
The following typographical conventions are used in this guide:

Typeface Purpose Example

Bold Used for keystrokes and window and dialog Click Fingerprint Enrollment.
box elements and to indicate data types
The Fingerprint Enrollment dialog box appears.
String that specifies a fingerprint reader serial
number

Courier Used to indicate computer programming code When SampleQualityGood is returned, the
bold OnComplete event is fired.
Deserializes a data object returned by the
IDPFPData::Serialize method.

Italics Used for emphasis or to introduce new terms This section includes illustrations of typical fingerprint
enrollment and fingerprint verification workflows.
If you are viewing this document online,
(emphasis)
clicking on text in italics may also activate a
hypertext link to other areas in this guide or to A fingerprint is an impression of the ridges on the skin
URLs. of a finger. (new term)
See Installing the SDK on page 8. (link to heading and
page)

Naming Conventions
DPFP stands for DigitalPersona Fingerprint.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 3
Chapter 1: Introduction Additional Resources

Additional Resources
You can refer to the resources in this section to assist you in using the One Touch for Windows SDK: COM/
ActiveX Edition.

Related Documentation

Subject Document

Fingerprint recognition, including the history and basics The DigitalPersona White Paper: Guide to Fingerprint
of fingerprint identification and the advantages of Recognition. The DigitalPersona White Paper: Guide to
DigitalPersona’s Fingerprint Recognition Engine Fingerprint Recognition. The file, Fingerprint Guide.pdf, is
located in the Docs folder in the One Touch for Java SDK
software package, and is not automatically installed on
your computer as part of the setup process.

Late-breaking news about the product The Readme.txt files provided in the root directory in the
SDK software package as well as in some subdirectories

Online Resources

Web Site name URL

DigitalPersona Developer Connection Forumfor peer-to http://www.digitalpersona.com/webforums/

peer interaction between DigitalPersona Developers

Latest updates for DigitalPersona software products http://www.digitalpersona.com/support/downloads/

software.php

System Requirements
This section lists the minimum software and hardware requirements needed to run the One Touch for Windows
SDK: COM/ActiveX Edition.
„ x86-based processor or better
„ Microsoft® Windows® XP, 32-bit and 64-bit versions; Microsoft® Windows® XP Embedded, 32-bit version1;
or Microsoft® Windows Vista®, 32-bit and 64-bit versions
„ USB connector on the computer where the fingerprint reader is to be connected
„ DigitalPersona U.are.U 4000B or U.are.U 2500 fingerprint reader

1. A list of DLL dependencies for installation of your application on Microsoft Windows XP Embedded, One Touch for Windows XPE Dependencies.xls, is
located in the Docs folder in the SDK software package.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 4
Chapter 1: Introduction Supported DigitalPersona Products

Supported DigitalPersona Products

The One Touch for Windows SDK: COM/ActiveX Edition supports the following DigitalPersona products:
„ DigitalPersona U.are.U 4000B fingerprint readers and modules
„ DigitalPersona U.are.U 2500 fingerprint readers and modules
„ DigitalPersona U.are.U Fingerprint Keyboard

Fingerprint Template Compatibility

Fingerprint templates produced by all editions of the One Touch for Windows SDK are also compatible with the
following DigitalPersona SDKs:
„ Gold SDK
„ Gold CE SDK
„ One Touch for Linux SDK, all distributions

NOTE: Platinum SDK registration templates must be converted to a compatible format to work with these
SDKs. See Appendix B on page 135 for sample code that converts Platinum SDK templates to this format.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 5
Quick Start 2

This chapter provides a quick introduction to the One Touch for Windows SDK: COM/ActiveX Edition using one
of the sample applications provided as part of the One Touch for Windows SDK.

The application is a Microsoft® Visual Basic® 6 project that demonstrates the functionality of the user interfaces
included in the DPFPEnrollmentControl and DPFPVerificationControl component objects.
The user interfaces are described in more detail in DPFPEnrollmentControl Object User Interface on page 116 and
DPFPVerificationControl Object User Interface on page 125.

Quick Concepts
The following definitions will assist you in understanding the purpose and functionality of the sample
application that is described in this section.

Enrollment—The process of capturing a person’s fingerprint four times, extracting the features from the
fingerprints, creating a fingerprint template, and storing the template for later comparison.

Verification—The process of comparing a captured fingerprint to a fingerprint template to determine whether

the two match.

Unenrollment—The process of deleting a fingerprint template associated with a previously enrolled

fingerprint.

For further descriptions of these processes, see Chapter 4 on page 17.

Install the Software

Before you can use the sample application, you must install the One Touch for Windows SDK: COM/ActiveX
Edition, which includes the runtime environment (RTE).

To install the One Touch for Windows SDK: COM/ActiveX Edition

1. In the SDK folder in the SDK software package, open the Setup.exe file, and then click Next.

2. Follow the installation instructions as they appear.

3. Restart your computer.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 6
Chapter 2: Quick Start Insert the Fingerprint Reader

Insert the Fingerprint Reader

Insert the fingerprint reader into the USB connector on the system where you installed the SDK.

Using the Sample Application

By performing the exercises in this section, you will
„ Start the sample application
„ Enroll a fingerprint
„ Verify a fingerprint
„ Unenroll (delete) a fingerprint
„ Exit the sample application

To start the sample application

„ Open the UIVBDemo.exe file located in the <destination folder>One Touch SDK\COM-ActiveX\Samples\
VB6\UI Support folder.
The VB Demo dialog box appears.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 7
Chapter 2: Quick Start Using the Sample Application

Enrolling a fingerprint consists of scanning your fingerprint four times using the fingerprint reader.

To enroll a fingerprint
1. In the VB Demo dialog box, click Enroll Fingerprints.
The Fingerprint Enrollment dialog box appears.

2. In the right “hand,” click the index finger.

A second Fingerprint Enrollment dialog box appears.

3. Using the fingerprint reader, scan your right index fingerprint.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 8
Chapter 2: Quick Start Using the Sample Application

4. Repeat step 3 until the Enrollment was successful message appears.

5. Click Close.

To verify a fingerprint
1. In the VB Demo dialog box, click Verify Fingerprint.
The Verify Your Identify dialog box appears.

2. Using the fingerprint reader, scan your right index fingerprint.

In the Verify Your Identify dialog box, a green check mark appears over the fingerprint, which indicates
that your fingerprint was verified.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 9
Chapter 2: Quick Start Using the Sample Application

3. Using the fingerprint reader, scan your right middle fingerprint.

In the Verify Your Identify dialog box, a red question mark appears over the fingerprint, which indicates
that your fingerprint was not verified.

4. Click Close.

To unenroll (delete) a fingerprint

1. In the VB Demo dialog box, click Enroll Fingerprints.
The Fingerprint Enrollment dialog box appears, indicating that you have enrolled your right index
fingerprint.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 10
Chapter 2: Quick Start Using the Sample Application

2. On the right “hand,” click the green index finger.

A message box appears, asking you to verify the unenrollment (deletion).

3. In the message box, click Yes.

The right index finger is no longer green, indicating that the fingerprint associated with that finger is not
enrolled, or has been deleted.

To exit the application

„ In the VB Demo dialog box, click Quit.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 11
Installation 3

This chapter contains instructions for installing the various components of the One Touch for Windows SDK:
COM/ActiveX Edition and identifies the files and folders that are installed on your hard disk.

The following two installations are located in the SDK software package:
„ SDK, which you use in developing your application. This installation is located in the SDK folder.
„ RTE (runtime environment), which you must provide to your end users to implement the One Touch for
Windows SDK: COM/ActiveX Edition components. This installation is located in the RTE folder. (The RTE
installation is also included in the SDK installation.)

Installing the SDK

NOTE: All installations share the DLLs and the DPHostW.exe file that are installed with the C/C++ edition.
Additional product-specific files are provided for other editions.

To install the One Touch for Windows SDK: COM/ActiveX Edition for 32-bit operating systems
1. In the SDK folder in the SDK software package, open the Setup.exe file, and then click Next.

2. Follow the installation instructions as they appear.

3. Restart your computer.

To install the One Touch for Windows SDK: COM/ActiveX Edition for 64-bit operating systems
1. In the SDK\x64 folder in the SDK software package, open the Setup.exe file, and then click Next.

2. Follow the installation instructions as they appear.

3. Restart your computer.

Table 1 describes the files and folders that are installed in the <destination folder> folder on your hard disk for
the 32-bit and 64-bit installations. The RTE files and folders, which are described in Table 2 on page 14 for the
32-bit installation and in Table 3 on page 15 for the 64-bit installation, are also installed on your hard disk.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 12
Chapter 3: Installation Installing the Runtime Environment (RTE)

Table 1. One Touch for Windows SDK: COM/ActiveX Edition installed files and folders

Folder File Description

One Touch SDK\COM- One Touch for Windows SDK DigitalPersona One Touch for Windows SDK:
ActiveX\Docs COM-ActiveX Developer COM/ActiveX Edition Developer Guide
Guide.pdf

One Touch SDK\COM- This folder contains a sample Microsoft Visual Basic 6 project that shows how to use
ActiveX\Samples\VB6\ the One Touch for Windows: COM/ActiveX Edition API for performing fingerprint
Enrollment Sample enrollment and fingerprint verification.

One Touch SDK\COM- This folder contains a sample Microsoft Visual Basic 6 project that demonstrates the
ActiveX\Samples\VB6\UI functionality of the user interfaces included in the DPFPEnrollmentControl and
Support DPFPVerificationControl component objects of the One Touch for Windows: COM/
ActiveX Edition API.

Installing the Runtime Environment (RTE)

When you develop a product based on the One Touch for Windows SDK: COM/ActiveX Edition, you need to
provide the redistributables to your end users. These files are designed and licensed for use with your
application. You may include the installation files located in the RTE\Install folder in your application or you
may incorporate the redistributables directly into your installer. You may also use the merge modules located
in the Redist folder in the SDK software package to create your own MSI installer. (See Redistribution on
page 127 for licensing terms.)

If you created an application based on the One Touch for Windows: COM/ActiveX Edition APIs that does not
include an installer, your end users must install the One Touch for Windows: COM/ActiveX Edition Runtime
Environment to run your application. The latest version of the RTE is available from the DigitalPersona Web site
at http://www.digitalpersona.com/support/downloads/software.php.

To install the One Touch for Windows: COM/ActiveX Edition Runtime Environment for 32-bit operating
systems
1. \In the RTE folder in the SDK software package, open the Setup.exe file.

2. Follow the installation instructions as they appear.

Table 2 identifies the files that are installed on your hard disk.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 13
Chapter 3: Installation Installing the Runtime Environment (RTE)

Table 2. One Touch for Windows: COM/ActiveX Edition RTE installed files and folders, 32-bit installation

Folder File Description

<destination folder>\Bin DPCOper2.dll DLLs and executable file used by the all of the
One Touch for Windows APIs
DPDevice2.dll
DPDevTS.dll
DpHostW.exe
DPmsg.dll
DPMux.dll
DpSvInfo2.dll
DPTSClnt.dll
DPCrStor.dll

<destination folder>\Bin\ DPFPShrX.dll DLLs used by the One Touch for Windows: COM/
COM-ActiveX ActiveX Edition API
DPFPDevX.dll
DPFPEngX.dll
DPFPCtlX.dll

<system folder> DPFPApi.dll DLLs used by all of the One Touch for Windows
SDK APIs
DpClback.dll
dpHFtrEx.dll
dpHMatch.dll
DPFpUI.dll

To install the One Touch for Windows: COM/ActiveX Edition Runtime Environment for 64-bit operating
systems
1. In the RTE\x64 folder in the SDK software package, open the Setup.exe file.

2. Follow the installation instructions as they appear.

Table 3 identifies the files that are installed on your hard disk for 64-bit versions of the supported operating
systems.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 14
Chapter 3: Installation Installing the Runtime Environment (RTE)

Table 3. One Touch for Windows: COM/ActiveX Edition RTE installed files and folders, 64-bit installation

Folder File Description

<destination folder>\Bin DPCOper2.dll DLLs and executable file used by the all of the
One Touch for Windows APIs
DPDevice2.dll
DPDevTS.dll
DpHostW.exe
DPMux.dll
DpSvInfo2.dll
DPTSClnt.dll
DPCrStor.dll

<destination folder>\Bin\x64 DPmsg.dll DLL used by the all of the One Touch for
Windows APIs

<destination folder>\Bin\ DPFPShrX.dll 32-bit DLLs used by the One Touch for Windows:
ActiveX COM/ActiveX Edition API
DPFPEngX.dll
DPFPDevX.dll
DPFPCtlX.dll

<destination folder>\Bin\ DPFPShrX.dll 64-bit DLLs used by the One Touch for Windows:
ActiveX\x64 COM/ActiveX Edition API
DPFPEngX.dll
DPFPDevX.dll
DPFPCtlX.dll

<system folder> DPFPApi.dll 32-bit DLLs used by all of the One Touch for
Windows APIs
DpClback.dll
dpHFtrEx.dll
dpHMatch.dll
DPFpUI.dll

<system64 folder> DPFPApi.dll 64-bit DLLs used by all of the One Touch for
Windows APIs
DpClback.dll
dpHFtrEx.dll
dpHMatch.dll
DPFpUI.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 15
Chapter 3: Installation Installing and Uninstalling the RTE Silently

Installing and Uninstalling the RTE Silently

The One Touch for Windows SDK software package contains a batch file, InstallOnly.bat, that you can use to
silently install the RTE. In addition, you can modify the file to selectively install the various features of the RTE.
Refer to the file for instructions.

The SDK software package also contains a file, UninstallOnly.bat, that you can use to silently uninstall the RTE.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 16
Overview 4

This chapter introduces One Touch for Windows SDK: COM/ActiveX Edition concepts and terminology. (For
more details on the subject of fingerprint biometrics, refer to the “DigitalPersona White Paper: Guide to
Fingerprint Recognition” included in the One Touch for Windows SDK software package.) This chapter also
includes typical workflow diagrams and explanations of the One Touch for Windows: COM/ActiveX Edition API
functions used to perform the tasks in the workflows.

Biometric System
A biometric system is an automatic method of identifying a person based on the person’s unique physical and/
or behavioral traits, such as a fingerprint or an iris pattern, or a handwritten signature or voice. Biometric
identifiers are
„ Universal
„ Distinctive
„ Persistent (sufficiently unchangeable over time)
„ Collectable

Biometric systems have become an essential component of effective person recognition solutions because
biometric identifiers cannot be shared or misplaced and they naturally represent an individual’s bodily identity.
Substitute forms of identity, such as passwords (commonly used in logical access control) and identity cards
(frequently used for physical access control), do not provide this level of authentication that strongly validates
the link to the actual authorized user.

Fingerprint recognition is the most popular and mature biometric system used today. In addition to meeting
the four criteria above, fingerprint recognition systems perform well (that is, they are accurate, fast, and
robust), they are publicly acceptable, and they are hard to circumvent.

Fingerprint
A fingerprint is an impression of the ridges on the skin of a finger. A fingerprint recognition system uses the
distinctive and persistent characteristics from the ridges, also referred to as fingerprint features, to distinguish
one finger (or person) from another. The One Touch for Windows SDK: COM/ActiveX Edition incorporates the
DigitalPersona Fingerprint Recognition Engine (Engine), which uses traditional as well as modern fingerprint
recognition methodologies to convert these fingerprint features into a format that is compact, distinguishing,
and persistent. The Engine then uses the converted, or extracted, fingerprint features in comparison and
decision-making to provide reliable personal recognition.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 17
Chapter 4: Overview Fingerprint Recognition

Fingerprint Recognition
The DigitalPersona fingerprint recognition system uses the processes of fingerprint enrollment and fingerprint
verification, which are illustrated in the block diagram in Figure 1 on page 19. Some of the tasks in these
processes are done by the fingerprint reader and its driver; some are accomplished using One Touch for
Windows: COM/ActiveX Edition API functions, which use the Engine; and some are provided by your software
application and/or hardware.

Fingerprint Enrollment
Fingerprint enrollment is the initial process of collecting fingerprint data from an enrollee and storing the
resulting data as a fingerprint template for later comparison. The following procedure describes typical
fingerprint enrollment. (Steps preceded by an asterisk are not performed by the One Touch for Windows SDK:
COM/ActiveX Edition.)

1. *Obtain the enrollee’s identifier (Subject Identifier).

2. Capture the enrollee’s fingerprint using the fingerprint reader.

3. Extract the fingerprint feature set for the purpose of enrollment from the fingerprint sample.

4. Repeat steps 2 and 3 until you have enough fingerprint feature sets to create a fingerprint template.

5. Create a fingerprint template.

6. *Associate the fingerprint template with the enrollee through a Subject Identifier, such as a user name,
email address, or employee number.

7. *Store the fingerprint template, along with the Subject Identifier, for later comparison.
Fingerprint templates can be stored in any type of repository that you choose, such as a fingerprint
capture device, a smart card, or a local or central database.

Fingerprint Verification
Fingerprint verification is the process of comparing the fingerprint data to the fingerprint template produced at
enrollment and deciding if the two match. The following procedure describes typical fingerprint verification.
(Steps preceded by an asterisk are not performed by the One Touch for Windows SDK: COM/ActiveX Edition.)

1. *Obtain the Subject Identifier of the person to be verified.

2. Capture a fingerprint sample using the fingerprint reader.

3. Extract a fingerprint feature set for the purpose of verification from the fingerprint sample.

4. *Retrieve the fingerprint template associated with the Subject Identifier from your repository.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 18
Chapter 4: Overview False Positives and False Negatives

5. Perform a one-to-one comparison between the fingerprint feature set and the fingerprint template, and
make a decision of match or non-match.

6. *Act on the decision accordingly, for example, unlock the door to a building for a match, or deny access to
the building for a non-match.

)LQJHUSULQW(QUROOPHQW

*HW6XEMHFW,GHQWLILHU

&UHDWHILQJHUSULQW 6WRUHWHPSODWHDQG
&DSWXUHILQJHUSULQWV &UHDWHWHPSODWH
IHDWXUHVHWV 6XEMHFW,GHQWLILHU

)LQJHUSULQW9HULILFDWLRQ

5HWULHYHWHPSODWHDQG
*HW6XEMHFW,GHQWLILHU
6XEMHFW,GHQWLILHU

&UHDWHILQJHUSULQW &RPSDUHDQG 8VHGHFLVLRQLQ

&DSWXUHILQJHUSULQW
IHDWXUHVHW PDNHGHFLVLRQ DSSOLFDWLRQ

/HJHQG
3HUIRUPHGE\2QH7RXFKIRU:LQGRZV6'.&&
1RWSHUIRUPHGE\2QH7RXFKIRU:LQGRZV6'.&&

Figure 1. DigitalPersona fingerprint recognition system

False Positives and False Negatives

Fingerprint recognition systems provide many security and convenience advantages over traditional methods
of recognition. However, they are essentially pattern recognition systems that inherently occasionally make
certain errors, because no two impressions of the same finger are identical. During verification, sometimes a
person who is legitimately enrolled is rejected by the system (a false negative decision), and sometimes a
person who is not enrolled is accepted by the system (a false positive decision).

The proportion of false positive decisions is known as the false accept rate (FAR), and the proportion of false
negative decisions is known as the false reject rate (FRR). In fingerprint recognition systems, the FAR and the FRR
are traded off against each other, that is, the lower the FAR, the higher the FRR, and the higher the FAR, the
lower the FRR.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 19
Chapter 4: Overview Workflows

A One Touch for Windows: COM/ActiveX Edition API function enables you to set the value of the FAR, also
referred to as the security level, to accommodate the needs of your application. In some applications, such as an
access control system to a highly confidential site or database, a lower FAR is required. In other applications,
such as an entry system to an entertainment theme park, security (which reduces ticket fraud committed by a
small fraction of patrons by sharing their entry tickets) may not be as significant as accessibility for all of the
patrons, and it may be preferable to decrease the FRR at the expense of an increased FAR.

It is important to remember that the accuracy of the fingerprint recognition system is largely related to the
quality of the fingerprint. Testing with sizable groups of people over an extended period has shown that a
majority of people have feature-rich, high-quality fingerprints. These fingerprints will almost surely be
recognized accurately by the DigitalPersona Fingerprint Recognition Engine and practically never be falsely
accepted or falsely rejected. The DigitalPersona fingerprint recognition system is optimized to recognize
fingerprints of poor quality. However, a very small number of people may have to try a second or even a third
time to obtain an accurate reading. Their fingerprints may be difficult to verify because they are either worn
from manual labor or have unreadable ridges. Instruction in the proper use of the fingerprint reader will help
these people achieve the desired results.

Workflows
Typical workflows are presented in this section for the following operations:
„ Fingerprint enrollment
„ Fingerprint enrollment with UI support
„ Fingerprint verification
„ Fingerprint verification with UI support
„ Fingerprint data object serialization and deserialization

NOTE: Steps preceded by two asterisks (**) are done by a fingerprint reader, and steps preceded by an asterisk
(*) are performed by an application. “VB page nn” and “C++ page nn” indicate page references for the
Visual Basic API reference and for the C++ API reference, respectively.

Fingerprint Enrollment Workflow

This section contains a typical workflow for performing fingerprint enrollment. The workflow is illustrated in
Figure 2 and is followed by explanations of the One Touch for Windows: COM/ActiveX Edition API functions
used to perform the tasks in the workflow.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 20
Chapter 4: Overview Fingerprint Enrollment Workflow

)LQJHUSULQW6DPSOH&DSWXUH
,PSOHPHQWHYHQWKDQGOHU
&UHDWH'3)3&DSWXUHREMHFW IRU'3)3&DSWXUH(YHQW 6HW'3)3&DSWXUHSURSHUWLHV
3ULRULW\5HDGHU6HULDO1XPEHU
HYHQWQRWLILFDWLRQV

%HJLQFDSWXULQJILQJHUSULQW 5HFHLYH2Q&RPSOHWH
VDPSOHVIURPILQJHUSULQWUHDGHU &DSWXUHILQJHUSULQWVDPSOH HYHQWZLWK
6WDUW&DSWXUHPHWKRG '3)36DPSOHREMHFW

6WRSFDSWXULQJ
ILQJHUSULQWVDPSOHV
6WRS&DSWXUHPHWKRG

)LQJHUSULQW)HDWXUH([WUDFWLRQ
&UHDWH &UHDWH'3)3)HDWXUH6HWREMHFWXVLQJ
'3)3)HDWXUH([WUDFWLRQ 'DWD3XUSRVH(QUROOPHQW
REMHFW &UHDWH)HDWXUH6HWPHWKRG

5HFHLYH
'3)3)HDWXUH6HWREMHFWV

)LQJHUSULQW(QUROOPHQW
3HUIRUPV\VWHPIXQFWLRQRI
&UHDWH ILQJHUSULQWHQUROOPHQWDQG
'3)3(QUROOPHQWREMHFW UHWXUQ'3)37HPSODWHREMHFW
$GG)HDWXUHVPHWKRG

&OHDUILQJHUSULQWWHPSODWHDQG
5HFHLYH VHW7HPSODWH6WDWXVWR
'3)37HPSODWHREMHFW 7HPSODWH6WDWXV8QNQRZQ
&OHDUPHWKRG

6WRUHVHULDOL]HGILQJHUSULQW
6HULDOL]H'3)37HPSODWHREMHFW
WHPSODWHGDWDLQILQJHUSULQW
IRUVWRUDJH
GDWDVWRUDJHVXEV\VWHP

/HJHQG
% 2QH7RXFKIRU:LQGRZV6'.&20$FWLYH;
2SWLRQDOVWHS

$SSOLFDWLRQQRWSDUWRI6'.
)LQJHUSULQWUHDGHU

Figure 2. Typical fingerprint enrollment workflow

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 21
Chapter 4: Overview Fingerprint Enrollment Workflow

Fingerprint Sample Capture

1. *Create an instance of a DPFPCapture object (VB page 36, C++ page 73).

2. *Implement an event handler for DPFPCaptureEvents event notifications (VB page 38, C++
page 76).

3. Optionally, set the Priority and ReaderSerialNumber properties (VB page 36 and page 37; C++
page 73 and page 74).

4. Begin capturing fingerprint samples from the fingerprint reader by calling the StartCapture
method (VB page 36, C++ page 74).

5. **Capture a fingerprint sample from a fingerprint reader.

6. *Receive the OnComplete event with a DPFPSample object when the fingerprint sample is
successfully captured by the fingerprint reader (VB page 38, C++ page 76).

7. *Pass the DPFPSample object to the DPFPFeatureExtraction method. (See step 2 in the next
section.)

8. Stop capturing fingerprint samples by calling the StopCapture method (VB page 36, C++ page 75).

Fingerprint Feature Extraction

1. *Create an instance of a DPFPFeatureExtraction object (VB page 48, C++ page 88).

2. Create DPFPFeatureSet objects by calling the CreateFeatureSet method using the value
DataPurposeEnrollment and passing a DPFPSample object from step 7 of the previous section
(VB page 48, C++ page 88).

3. *Pass the DPFPFeatureSet objects created in the previous step to the AddFeatures method.

Fingerprint Enrollment
1. *Create an instance of a DPFPEnrollment object (VB page 41, C++ page 80).

2. Perform the system function of fingerprint enrollment by calling the AddFeatures method and
passing the DPFPFeatureSet objects (VB page 41, C++ page 80).
When the TemplateStatus property returns the value TemplateStatusReady, a
DPFPTemplate object is created (VB page 42, C++ page 81).

3. *Receive the DPFPTemplate object.

4. Serialize the DPFPTemplate object (see Serializing a Fingerprint Data Object on page 32).

5. *Store the serialized fingerprint template data in a fingerprint data storage subsystem.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 22
Chapter 4: Overview Fingerprint Enrollment with UI Support

6. Clear the fingerprint template and set the value of TemplateStatus to

TemplateStatusUnknown by calling the Clear method (VB page 41, C++ page 80).

Fingerprint Enrollment with UI Support

This section contains two typical workflows for performing fingerprint enrollment: one for enrolling a
fingerprint and one for unenrolling (deleting) a fingerprint template. The workflows are illustrated in Figure 3
and Figure 4 and are followed by explanations of the One Touch for Windows: COM/ActiveX Edition API
functions used to perform the tasks in the workflows.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 23
Chapter 4: Overview Fingerprint Enrollment with UI Support

Enrolling a Fingerprint

)LQJHUSULQW(QUROOPHQW&RQWURO±(QUROO)LQJHUSULQW
,PSOHPHQWHYHQWKDQGOHUIRU
&UHDWH'3)3(QUROOPHQW&RQWURO
'3)3(QUROOPHQW&RQWURO(YHQWVHYHQW
REMHFW
QRWLILFDWLRQV

6HW'3)3(QUROOPHQW&RQWURO 6HW'3)3(QUROOPHQW&RQWURO
SURSHUW\ SURSHUWLHV
(QUROOHG)LQJHUV0DVN 0D[(QUROO)LQJHU&RXQW5HDGHU6HULDO1XPEHU

5HFHLYH2Q(QUROOHYHQWZLWK
&DSWXUHILQJHUSULQWVDPSOH
'3)37HPSODWHREMHFW

6HULDOL]H'3)37HPSODWH 6WRUHVHULDOL]HGILQJHUSULQWGDWD
REMHFWIRUVWRUDJH LQILQJHUSULQWGDWDVWRUDJHVXEV\VWHP

6WRUHQHZ(QUROOHG)LQJHUV0DVN
LQILQJHUSULQWGDWDVWRUDJHVXEV\VWHP

6HWDSSURSULDWHYDOXHIRU
'3)3(YHQW+DQGOHU6WDWXVREMHFW

/HJHQG
% 2QH7RXFKIRU:LQGRZV6'.&20$FWLYH;
2SWLRQDOVWHS

$SSOLFDWLRQQRWSDUWRI6'.
)LQJHUSULQWUHDGHU

Figure 3. Typical fingerprint enrollment with UI support workflow: Enrolling a fingerprint

1. *Create an instance of a DPFPEnrollmentControl object (VB page 43, C++ page 82).

2. *Implement an event handler for DPFPEnrollmentControlEvents event notifications (VB

page 46, C++ page 85).

3. Set the EnrolledFingersMask property (VB page 43, C++ page 82).

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 24
Chapter 4: Overview Fingerprint Enrollment with UI Support

4. Optionally, set the MaxEnrollFingerCount and ReaderSerialNumber properties (VB page 44

and page 45; C++ page 84 and page 84).

5. **Capture a fingerprint sample from a fingerprint reader.

6. *Receive the OnEnroll event and the DPFPTemplate object (VB page 47, C++ page 86).

7. Serialize the DPFPTemplate object (see Serializing a Fingerprint Data Object on page 32).

8. *Store the serialized fingerprint template data and the new value of the EnrolledFingersMask in a
fingerprint data storage subsystem.

9. *Set the appropriate value for the DPFPEventHandlerStatus object (VB page 66, C++ page 111).

Unenrolling (Deleting) a Fingerprint Template

)LQJHUSULQW(QUROOPHQW&RQWURO±8QHQUROO)LQJHUSULQW
,PSOHPHQWHYHQWKDQGOHUIRU
&UHDWH'3)3(QUROOPHQW&RQWURO
'3)3(QUROOPHQW&RQWURO(YHQWV
REMHFW
HYHQWQRWLILFDWLRQV

6HW'3)3(QUROOPHQW&RQWURO 5HFHLYH2Q'HOHWHHYHQW
SURSHUW\ ZLWKLQGH[YDOXH
(QUROOHG)LQJHUV0DVN

'HOHWHDSSURSULDWHILQJHUSULQW
6WRUHQHZ(QUROOHG)LQJHUV0DVN
WHPSODWHIURPILQJHUSULQWGDWD
LQILQJHUSULQWGDWDVWRUDJHVXEV\VWHP
VWRUDJHVXEV\VWHP

6HWDSSURSULDWHYDOXHIRU
'3)3(YHQW+DQGOHU6WDWXVREMHFW

/HJHQG
2QH7RXFKIRU:LQGRZV6'.&20$FWLYH;
2SWLRQDOVWHS

$SSOLFDWLRQQRWSDUWRI6'.

Figure 4. Typical fingerprint enrollment with UI support workflow: Unenrolling a fingerprint template

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 25
Chapter 4: Overview Fingerprint Verification

1. *Create an instance of a DPFPEnrollmentControl object (VB page 43, C++ page 82).

2. *Implement an event handler for DPFPEnrollmentControlEvents event notifications (VB

page 46, C++ page 85).

3. Set the EnrolledFingersMask property (VB page 43, C++ page 82).

4. *Receive the OnDelete event, along with the finger index value (VB page 46 and page 44; C++ page 86
and page 86).

5. *Delete the appropriate fingerprint template from the fingerprint data storage subsystem.

6. *Store the new value of the EnrolledFingersMask in the fingerprint data storage subsystem.

7. *Set the appropriate value for the DPFPEventHandlerStatus object (VB page 66, C++ page 111).

Fingerprint Verification
This section contains a typical workflow for performing fingerprint verification. The workflow is illustrated in
Figure 5 and is followed by explanations of the One Touch for Windows: COM/ActiveX Edition API functions
used to perform the tasks in the workflow.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 26
Chapter 4: Overview Fingerprint Verification

)LQJHUSULQW6DPSOH&DSWXUH
,PSOHPHQWHYHQWKDQGOHU
&UHDWH'3)3&DSWXUHREMHFW IRU'3)3&DSWXUH(YHQW 6HW'3)3&DSWXUHSURSHUWLHV
3ULRULW\5HDGHU6HULDO1XPEHU
HYHQWQRWLILFDWLRQV

%HJLQFDSWXULQJILQJHUSULQW 5HFHLYH2Q&RPSOHWH
VDPSOHVIURPILQJHUSULQWUHDGHU &DSWXUHILQJHUSULQWVDPSOH HYHQWZLWK
6WDUW&DSWXUHPHWKRG '3)36DPSOHREMHFW

6WRSFDSWXULQJ
ILQJHUSULQWVDPSOHV
6WRS&DSWXUHPHWKRG

)LQJHUSULQW)HDWXUH([WUDFWLRQ

&UHDWH &UHDWH'3)3)HDWXUH6HWREMHFWXVLQJ
'3)3)HDWXUH([WUDFWLRQ 'DWD3XUSRVH9HULILFDWLRQ
REMHFW &UHDWH)HDWXUH6HWPHWKRG

5HFHLYH
'3)3)HDWXUH6HWREMHFW

)LQJHUSULQW9HULILFDWLRQ

&UHDWH 6HW'3)39HULILFDWLRQSURSHUW\
'3)39HULILFDWLRQREMHFW )$55HTXHVWHG

3HUIRUPV\VWHPIXQFWLRQRIILQJHUSULQW
YHULILFDWLRQDQGUHWXUQ 5HFHLYH
'3)39HULILFDWLRQ5HVXOWREMHFW '3)39HULILFDWLRQ5HVXOWREMHFW
9HULI\PHWKRG

5HWULHYHGHVHULDOL]HG
'3)37HPSODWHREMHFW

/HJHQG
$ 2QH7RXFKIRU:LQGRZV6'.&20$FWLYH;
2SWLRQDOVWHS

$SSOLFDWLRQQRWSDUWRI6'.
)LQJHUSULQWUHDGHU

Figure 5. Typical fingerprint verification workflow

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 27
Chapter 4: Overview Fingerprint Verification

Fingerprint Sample Capture

1. *Create an instance of a DPFPCapture object (VB page 36, C++ page 73).

2. *Implement an event handler for DPFPCaptureEvents event notifications (VB page 38, C++
page 76).

3. Optionally, set the Priority and ReaderSerialNumber properties (VB page 36 and page 37; C++
page 73 and page 74).

4. Begin capturing fingerprint samples from the fingerprint reader by calling the StartCapture
method (VB page 36, C++ page 74).

5. **Capture a fingerprint sample from a fingerprint reader.

6. *Receive the OnComplete event with a DPFPSample object when the fingerprint sample is
successfully captured by the fingerprint reader (VB page 38, C++ page 76).

7. *Pass the DPFPSample object to the CreateFeatureSet method. (See step 2 in the next section.)

8. Stop capturing fingerprint samples by calling the StopCapture method (VB page 36, C++ page 75).

Fingerprint Feature Extraction

1. *Create an instance of a DPFPFeatureExtraction object (VB page 48, C++ page 88).

2. Create a DPFPFeatureSet object by calling the CreateFeatureSet method using the value
DataPurposeVerification and passing a DPFPSample object from step 7 in the previous
section (VB page 48, C++ page 88).

3. *Pass the DPFPFeatureSet object created in the previous step to the Verify method. (See step 5
in the next section.)

Fingerprint Verification
1. *Create an instance of a DPFPVerification object (VB page 59, C++ page 102).

2. Optionally, set the FARRequested property (VB page 59, C++ page 102). You can use this property to
check or modify the current value of the FAR.

3. Retrieve the serialized fingerprint template data from the fingerprint data storage subsystem.

4. Create a DPFPTemplate object from the serialized data (see Deserializing a Serialized Fingerprint Data
Object on page 33).

5. Perform the system function of fingerprint verification by calling the Verify method and passing the
DPFPTemplate object created in the previous step and DPFPFeatureSet object from step 3 in the
previous section (VB page 59, C++ page 103).

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 28
Chapter 4: Overview Fingerprint Verification with UI Support

6. *Receive the DPFPVerificationResult object, which provides the comparison decision of match
or non-match (VB page 62, C++ page 106).

Fingerprint Verification with UI Support

This section contains a typical workflow for performing fingerprint verification with UI support. The workflow is
illustrated in Figure 6 and is followed by explanations of the One Touch for Windows: COM/ActiveX Edition API
functions used to perform the tasks in the workflow.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 29
Chapter 4: Overview Fingerprint Verification with UI Support

)LQJHUSULQW9HULILFDWLRQ&RQWURO
,PSOHPHQWHYHQWKDQGOHUIRU
&UHDWH'3)39HULILFDWLRQ&RQWURO
'3)39HULILFDWLRQ&RQWURO(YHQWVHYHQW
REMHFW
QRWLILFDWLRQV

6HW'3)3(QUROOPHQW&RQWURO
SURSHUW\ &DSWXUHILQJHUSULQWVDPSOH
5HDGHU6HULDO1XPEHU

5HFHLYH2Q&RPSOHWH
HYHQWZLWK
'3)3)HDWXUH6HWREMHFW

)LQJHUSULQW9HULILFDWLRQ

&UHDWH 6HW'3)39HULILFDWLRQSURSHUW\
'3)39HULILFDWLRQREMHFW )$55HTXHVWHG

3HUIRUPV\VWHPIXQFWLRQ 5HFHLYH
RIILQJHUSULQWYHULILFDWLRQ '3)39HULILFDWLRQ5HVXOWREMHFW
DQGUHWXUQ
'3)39HULILFDWLRQ5HVXOWREMHFW
&UHDWH)HDWXUH6HWPHWKRG
6HWDSSURSULDWHYDOXHIRU
'3)3(YHQW+DQGOHU6WDWXV
REMHFW
5HWULHYHGHVHULDOL]HG
'3)37HPSODWHREMHFWV

/HJHQG
$ 2QH7RXFKIRU:LQGRZV6'.&20$FWLYH;
2SWLRQDOVWHS

$SSOLFDWLRQQRWSDUWRI6'.
)LQJHUSULQWUHDGHU

Figure 6. Typical fingerprint verification with UI support workflow

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 30
Chapter 4: Overview Fingerprint Verification with UI Support

Fingerprint Verification Control

1. *Create an instance of a DPFPVerificationControl object (VB page 60, C++ page 104).

2. Implement an event handler for DPFPVerificationControlEvents event notifications (VB

page 61, C++ page 106).

3. Optionally, set the ReaderSerialNumber property (VB page 60, C++ page 105).

4. **Capture a fingerprint sample from a fingerprint reader.

5. Receive the OnComplete event with the DPFPFeatureSet object (VB page 61, C++ page 106).

Fingerprint Verification
1. *Create an instance of a DPFPVerification object (VB page 59, C++ page 102).

2. Optionally, set the FARRequested property (VB page 59, C++ page 102). You can use this property to
check or modify the current value of the FAR.

3. Retrieve the serialized fingerprint template data from the fingerprint data storage subsystem.

4. Create a DPFPTemplate object from the serialized data (see Deserializing a Serialized Fingerprint Data
Object on page 33).

5. Perform the system function of fingerprint verification by calling the Verify method and passing the
DPFPTemplate and DPFPFeatureSet objects (VB page 59, C++ page 103).

6. *Receive the DPFPVerificationResult object, which provides the comparison decision of match
or non-match (VB page 62, C++ page 106).

7. *Set the appropriate value for the DPFPEventHandlerStatus object (VB page 66, C++ page 111).

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 31
Chapter 4: Overview Fingerprint Data Object Serialization/Deserialization

Fingerprint Data Object Serialization/Deserialization

This section contains two workflows: one for serializing a fingerprint data object and one for deserializing a
serialized fingerprint data object. The workflows are illustrated in Figure 7 and Figure 8 and are followed by
explanations of the One Touch for Windows: COM/ActiveX Edition API functions used to perform the tasks in
the workflows.

Serializing a Fingerprint Data Object

6HULDOL]H'3)37HPSODWHREMHFW

6HULDOL]H'3)37HPSODWH 6WRUHVHULDOL]HGGDWD
'3)37HPSODWHREMHFW REMHFW LQILQJHUSULQWGDWD
6HULDOL]HPHWKRG VWRUDJHVXEV\VWHP

/HJHQG
2QH7RXFKIRU:LQGRZV6'.&20$FWLYH;

$SSOLFDWLRQQRWSDUWRI6'.

Figure 7. Fingerprint data object serialization workflow: DPFPTemplate object

1. *Begin with a DPFPTemplate object. (See the various methods and properties for creating and
returning a DPFPTemplate object.)

2. Serialize the data object by calling the Serialize method (VB page 40, C++ page 79).

3. *Store the serialized data in a fingerprint data storage subsystem.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 32
Chapter 4: Overview Fingerprint Data Object Serialization/Deserialization

Deserializing a Serialized Fingerprint Data Object

'HVHULDOL]HGDWDREMHFW
5HWULHYHVHULDOL]HG
ILQJHUSULQWWHPSODWHGDWD 'HVHULDOL]H'3)37HPSODWH 5HWXUQ'3)37HPSODWH
IURPILQJHUSULQWGDWD REMHFW REMHFW
'HVHULDOL]HPHWKRG
VWRUDJHVXEV\VWHP

/HJHQG
2QH7RXFKIRU:LQGRZV6'.&20$FWLYH;

$SSOLFDWLRQQRWSDUWRI6'.

Figure 8. Deserialization of serialized fingerprint data object workflow: DPFPTemplate object

1. *Retrieve serialized fingerprint template data from a fingerprint data storage subsystem.

2. Deserialize a DPFPTemplate object by calling the Deserialize method (VB page 40, C++
page 78).

3. Return a DPFPTemplate object.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 33
API Reference for Visual Basic Developers 5

This chapter defines the API components for developing applications that incorporate the functionality of the
One Touch for Windows: COM/ActiveX Edition API in Visual Basic using the Component Object Model (COM)
implementation.

Component Objects
IMPORTANT: All of the read/write properties of the One Touch for Windows SDK API component objects are
optional. If you do not set one of these properties, the default value is automatically used. When
deciding whether to set a property, be aware that DigitalPersona may change the default values
at any time without notice. If you want your application’s functionality to remain consistent, you
should set the properties accordingly.

The One Touch for Windows: COM/ActiveX Edition API COM implementation includes the component objects
defined in this section. Use the following list to quickly locate an object by name, by page number, or by
description.

Method Page Description

DPFPCapture 36 Captures a fingerprint sample from a fingerprint reader

DPFPData 40 Represents the data that is common to all fingerprint data objects

DPFPEnrollment 41 Performs the system function of fingerprint enrollment

DPFPEnrollmentControl 43 Contains an ActiveX control for performing fingerprint enrollment

operations, and provides a user interface

DPFPEventHandlerStatus 47 Returns codes that indicate the status of an operation

DPFPFeatureExtraction 48 Performs the system function of fingerprint feature extraction

DPFPFeatureSet 49 Represents a fingerprint feature set

DPFPReaderDescription 50 Provides information about a particular fingerprint reader

DPFPReadersCollection 54 Provides information about all of the fingerprint readers connected to

a system

DPFPSample 56 Represents a fingerprint sample

DPFPSampleConversion 57 Returns a fingerprint sample as an image

DPFPTemplate 58 Represents a fingerprint template

DPFPVerification 59 Performs the system function of fingerprint verification

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 34
Chapter 5: API Reference for Visual Basic Developers Component Objects

Method Page Description

DPFPVerificationControl 60 Contains an ActiveX control for creating and returning a fingerprint

feature set created for the purpose of verification, and provides a user
interface

DPFPVerificationResult 62 Represents the results of a fingerprint verification operation

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 35
Chapter 5: API Reference for Visual Basic Developers DPFPCapture

DPFPCapture
The DPFPCapture object captures a fingerprint sample from a fingerprint reader.

Methods

StartCapture Method
Begins capturing a fingerprint sample from a fingerprint reader. A call to this method is asynchronous and
returns immediately. The application continues to receive events until the StopCapture method is called
or when the DPFPCapture object is destroyed.

Syntax
object.StartCapture()

Possible Errors

Error Code Message Description

-2147024809 One or more arguments A capture operation with the specified priority already
are invalid. exists. See DPFPCapturePriorityEnum on
page 65 for more information.

-2147024891 General access denied The application does not have sufficient privileges to
error. start capture operations with the specified priority. See
DPFPCapturePriorityEnum on page 65 for more
information.

StopCapture Method
Stops the fingerprint sample capture operation started with a call to the StartCapture method. This
method is optional.

Syntax
object.StopCapture()

Properties

Priority Property
Gets or sets a value that specifies the priority of a fingerprint sample capture operation.

Syntax
DPFPCapture.Priority [ = enumValue ]
[ enumValue = ] DPFPCapture.Priority

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 36
Chapter 5: API Reference for Visual Basic Developers DPFPCapture

Possible Values

enumValue Enum that specifies or receives one of the DPFPCapturePriorityEnum

enumeration values (page 65)

This optional property is read/write. If you do not set it, the value CapturePriorityNormal is used.

Possible Errors

Error Code Message Description

-2147352566 Out of present range. The data pointed to by the output parameter is
outside the range of possible values.

ReaderSerialNumber Property
Gets or sets the serial number of a fingerprint reader that captures a fingerprint sample.

Syntax
DPFPCapture.ReaderSerialNumber [ = bstrValue ]
[ bstrValue = ] DPFPCapture.ReaderSerialNumber

Possible Values

strValue String that specifies or receives a fingerprint reader serial number

This optional property is read/write. If you do not set it, the following value is used:
{00000000-0000-0000-0000-000000000000}. This means that the application will receive events
from any of the fingerprint readers attached to the system.

Possible Errors

Error Code Message Description

-2147024809 One or more arguments The format of the string containing the fingerprint
are invalid. reader serial number is incorrect. It should be in GUID
format, for example, {A9EFB3F6-A8C8-4684-841E-
4330973057C6}.

Object Information

Type library DigitalPersona One Touch for Windows Device components 1.0

Library DPFPDevX.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 37
Chapter 5: API Reference for Visual Basic Developers DPFPCapture

Events

OnComplete Event
Fires when a fingerprint sample is successfully captured by a fingerprint reader.

Syntax
Private Sub object_OnComplete(
ByVal bstrReaderSerNum As String,
ByVal oFingerprintSample As Object)

Parameters

bstrReaderSerNum String that specifies a fingerprint reader serial number

oFingerprintSample A DPFPSample object (page 56)

OnFingerGone Event
Fires when a user removes a finger from a fingerprint reader.

Syntax
Private Sub object_OnFingerGone(
ByVal bstrReaderSerNum As String)

Parameter

bstrReaderSerNum String that specifies a fingerprint reader serial number

OnFingerTouch Event
Fires when a user touches a fingerprint reader.

Syntax
Private Sub OnFingerTouch(
ByVal bstrReaderSerNum As String)

Parameter

bstrReaderSerNum String that specifies a fingerprint reader serial number

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 38
Chapter 5: API Reference for Visual Basic Developers DPFPCapture

OnReaderConnect Event
Fires when a fingerprint reader is attached to a system.

Syntax
Private Sub object_OnReaderConnect(
ByVal bstrReaderSerNum As String)

Parameter

bstrReaderSerNum String that specifies a fingerprint reader serial number

OnReaderDisconnect Event
Fires when a fingerprint reader is disconnected from a system.

Syntax
Private Sub object_OnReaderDisconnect(
ByVal bstrReaderSerNum As String)

Parameter

bstrReaderSerNum String that specifies a fingerprint reader serial number

OnSampleQuality Event
Fires when the quality of a fingerprint sample is verified. When SampleQualityGood is returned in the
SampleQuality parameter, the OnComplete event is fired (page 38).

Syntax
Private Sub object_OnSampleQuality(
ByVal bstrReaderSerNum As String,
ByVal enumSampleQuality As Enum)

Parameters

bstrReaderSerNum String that specifies a fingerprint reader serial number

enumSampleQuality Enum that specifies one of the values, which provides feedback about a
fingerprint sample capture operation, from the
DPFPCaptureFeedbackEnum enumeration (page 64)

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 39
Chapter 5: API Reference for Visual Basic Developers DPFPData

DPFPData
Represents the data that is common to all fingerprint data objects. The DPFPData object also provides
methods to serialize and deserialize fingerprint data objects.

Methods

Deserialize Method
Deserializes a data object returned by the Serialize method.

Syntax
object.Deserialize(
ByRef aRawData() As Byte)

Parameter

aRawData Array of bytes that specifies a deserialized data object

Possible Errors

Error Code Message Description

-2147024809 One or more arguments The format of the data passed to the Deserialize
are invalid. method is incorrect.

Serialize Method
Serializes a data object and returns it as an array of bytes.

Syntax
Dim aRawData As Byte()
aRawData = object.Serialize

Parameter

aRawData Array of bytes that receives a serialized data object

Object Information

Type library DigitalPersona One Touch for Windows Shared components 1.0

Library DPFPShrX.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 40
Chapter 5: API Reference for Visual Basic Developers DPFPEnrollment

See Also
DPFPFeatureSet on page 49
DPFPSample on page 56
DPFPTemplate on page 58

DPFPEnrollment
The DPFPEnrollment object performs the system function of fingerprint enrollment. This object creates a
fingerprint template from a specified number of fingerprint feature sets created for the purpose of enrollment.

Methods

AddFeatures Method
Adds fingerprint feature sets, one-by-one, to a fingerprint template. The fingerprint template is complete when
the TemplateStatus property is set to the value TemplateStatusReady.

Syntax
object.AddFeatures(
ByVal oFeatures As Object)

Parameter

oFeatures A DPFPFeatureSet object (page 49)

Clear Method
Clears a fingerprint template and sets the value of the TemplateStatus property to
TemplateStatusUnknown so an application can begin another fingerprint template creation operation.

Syntax
object.Clear()

Properties

FeaturesNeeded Property
Gets the number of fingerprint feature sets still needed to create a fingerprint template. When the value of
lValue is equal to 0, the fingerprint template is created.

Syntax
[ lValue = ] DPFPEnrollment.FeaturesNeeded

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 41
Chapter 5: API Reference for Visual Basic Developers DPFPEnrollment

Possible Values

lValue Long that receives the value of the number of fingerprint feature sets

This property is read-only and has no default value.

Template Property
Gets a DPFPTemplate object created during a fingerprint enrollment operation.

Syntax
[ oTemplate = ] DPFPEnrollment.Template

Possible Values

oTemplate A DPFPTemplate object (page 58)

This property is read-only and has no default value.

Possible Errors

Error Code Message Description

-2147352573 Member not found. A fingerprint template has not been created yet.

TemplateStatus Property
Gets a value that specifies the status of a fingerprint template creation operation.

Syntax
[ enumValue = ] DPFPEnrollment.TemplateStatus

Possible Values

enumValue Enum that receives one of the DPFPTemplateStatusEnum enumeration

values (page 70)

This property is read-only and has no default value.

Object Information

Type library DigitalPersona One Touch for Windows Engine components 1.0

Library DPFPEngX.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 42
Chapter 5: API Reference for Visual Basic Developers DPFPEnrollmentControl

DPFPEnrollmentControl
The DPFPEnrollmentControl object contains an ActiveX control that implements a user interface
(described in DPFPEnrollmentControl Object User Interface on page 116) and provides the following
functionality:
„ Captures fingerprint samples from a fingerprint reader(s)
„ Creates fingerprint feature sets for the purpose of enrollment
„ Creates fingerprint templates
„ Notifies an application when an enrollee commits to delete a fingerprint template
„ Fires events

Properties

EnrolledFingersMask Property
Gets or sets the mask representing the user’s enrolled fingerprints. The enrollment mask is a combination of
the values representing a user’s enrolled fingerprints. For example, if a user’s right index fingerprint and right
middle fingerprint are enrolled, the value of this property is 00000000 011000000, or 192.

Syntax
DPFPEnrollmentControl.EnrolledFingersMask [ = lValue ]
[ lValue = ] DPFPEnrollmentControl.EnrolledFingersMask

Possible Values

lValue Long that specifies or receives the value of the fingerprint mask. All possible
values are listed in Table 4.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 43
Chapter 5: API Reference for Visual Basic Developers DPFPEnrollmentControl

Table 4. Values for the enrollment mask

Finger Binary Representation Integer Representation

Left little finger 000000000 000000001 1

Left ring finger 000000000 000000010 2

Left middle finger 000000000 000000100 4

Left index finger 000000000 000001000 8

Left thumb 000000000 000010000 16

Right thumb 000000000 000100000 32

Right index finger 000000000 001000000 64

Right middle finger 000000000 010000000 128

Right ring finger 000000000 100000000 256

Right little finger 000000001 000000000 512

This optional property is read/write. If you do not set it, the value 0 is used, which means that no
fingerprints have been enrolled.

Possible Errors

Error Code Message Description

-2147352566 Out of present range. The data pointed to by the output parameter is
outside the range of possible values.

MaxEnrollFingerCount Property
Gets or sets the value for the maximum number of fingerprints that can be enrolled.

Syntax
DPFPEnrollmentControl.MaxEnrollFingerCount [ = lValue ]
[ lValue = ] DPFPEnrollmentControl.MaxEnrollFingerCount

Possible Values

lValue Long that specifies or receives the value for the maximum number of fingerprints
that can be enrolled. Possible values are 1 through 10.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 44
Chapter 5: API Reference for Visual Basic Developers DPFPEnrollmentControl

This optional property is read/write. If you do not set it, the value 10 is used, which means the user can
enroll all ten fingerprints.

Possible Errors

Error Code Message Description

-2147352566 Out of present range. The data pointed to by the output parameter is
outside the range of possible values.

ReaderSerialNumber Property
Gets or sets the serial number of the fingerprint reader from which a fingerprint sample is captured.

Syntax
DPFPEnrollmentControl.ReaderSerialNumber [ = bstrValue ]
[ bstrValue = ] DPFPEnrollmentControl.ReaderSerialNumber

Possible Values

bstrValue String that specifies or receives the fingerprint reader serial number

This optional property is read/write. If you do not set it, the following value is used:
{00000000-0000-0000-0000-000000000000}. This means that the application will receive events
from any of the fingerprint readers attached to the system.

Possible Errors

Error Code Message Description

-2147024809 One or more arguments The format of the string containing the fingerprint
are invalid. reader serial number is incorrect. It should be in GUID
format, for example, {A9EFB3F6-A8C8-4684-841E-
4330973057C6}.

Object Information

Type library DigitalPersona One Touch for Windows Control 1.0

Library DPFPCtlX.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 45
Chapter 5: API Reference for Visual Basic Developers DPFPEnrollmentControl

Events

OnDelete Event
Fires when a user commits to delete an enrolled fingerprint. The application handles the deletion of the
fingerprint template from a fingerprint data storage subsystem and can display its own success or error
messages.

Syntax
Private Sub object_OnDelete(
ByVal l1FingerMask As Long,
ByVal oStatus As Object)

Parameters

l1FingerMask Long that specifies the index value of the (enrolled) fingerprint to be deleted.
For possible values, see Table 5.

oStatus A DPFPEventHandlerStatus object (page 47)

The l1FingerMask parameter is the index value of the finger associated with a fingerprint to be
enrolled or a fingerprint template to be deleted, as defined in ANSI/NIST-ITL 1. The index values are assigned
to the graphical representation of the fingers on the hands in the user interface. All possible values are listed
in Table 5.

Table 5. Finger index values in ANSI/NIST-ITL 1

Finger Index Value Finger Index Value

Right thumb 1 Left thumb 6

Right index finger 2 Left index finger 7

Right middle finger 3 Left middle finger 8

Right ring finger 4 Left ring finger 9

Right little finger 5 Left little finger 10

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 46
Chapter 5: API Reference for Visual Basic Developers DPFPEventHandlerStatus

OnEnroll Event
Fires when a user enrolls a fingerprint and returns a fingerprint template. The application handles the storage
of the fingerprint template in a fingerprint data storage subsystem and can display its own success or error
messages.

Syntax
Private Sub object_OnEnroll(
ByVal l1FingerMask As Long,
ByVal oFingerprintTemplate As Object,
ByVal oStatus As Object)

Parameters

l1FingerMask Long that specifies the index value for the enrolled fingerprint. For
possible values, see Table 5 on page 46.

oFingerprintTemplate A DPFPTemplate object (page 58)

oStatus A DPFPEventHandlerStatus object (page 47)

DPFPEventHandlerStatus
The DPFPEventHandlerStatus object returns codes that indicate the status of an operation.

Properties

Status Property
Gets or sets the status of an operation performed by a DPFPEnrollmentControl object (page 43) or by a
DPFPVerificationControl object (page 60).

Syntax
DPFPEventHandlerStatus.Status [ = enumValue ]
[ enumValue = ] DPFPEventHandlerStatus.Status

Possible Values

enumValue Enum that specifies or receives one of the values from the
DPFPEventHandlerStatusEnum enumeration (page 66)

This optional property is read/write. If you do not set it, the value DPFPEventHandlerStatusSuccess
is used.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 47
Chapter 5: API Reference for Visual Basic Developers DPFPFeatureExtraction

Possible Errors

Error Code Message Description

-2147352566 Out of present range. The data pointed to by the output parameter is
outside the range of possible values.

Object Information

Type library DigitalPersona One Touch for Windows Control 1.0

Library DPFPCtlX.dll

DPFPFeatureExtraction
The DPFPFeatureExtraction object performs fingerprint feature extraction. This object creates a
fingerprint feature set for the purpose of enrollment or verification by applying fingerprint feature extraction to
a fingerprint sample.

Method

CreateFeatureSet Method
Applies fingerprint feature extraction to a fingerprint sample and then creates a fingerprint feature set for the
specified purpose.

Syntax
Dim enumSampleQuality As DPFPCaptureFeedbackEnum
enumSampleQuality = object.CreateFeatureSet(
ByVal oFingerprintSample As Object,
ByVal enumPurpose As Enum)

Parameters

oFingerprintSample A DPFPSample object (page 56)

enumPurpose Enum that specifies one of the values, which is for the specified purpose,
from the DPFPDataPurposeEnum enumeration (page 67)

enumSampleQuality Enum the receives one of the values, which provides feedback about a
fingerprint sample capture operation, from the
DPFPCaptureFeedbackEnum enumeration (page 64)

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 48
Chapter 5: API Reference for Visual Basic Developers DPFPFeatureSet

Property

FeatureSet Property
Retrieves a DPFPFeatureSet object created during a fingerprint feature extraction operation.

Syntax
[ oFeatureSet = ] DPFPFeatureExtraction.FeatureSet

Possible Values

oFeatureSet A DPFPFeatureSet object (page 49)

This property is read-only and has no default value.

Possible Errors

Error Code Message Description

-2147352573 Member not found. A fingerprint feature set has not been created yet.

Object Information

Type library DigitalPersona One Touch for Windows Engine components 1.0

Library DPFPEngX.dll

DPFPFeatureSet
The DPFPFeatureSet object represents a fingerprint feature set.

Methods

Deserialize Method
Deserializes a data object returned by the Serialize method.

Syntax
object.Deserialize(
ByRef aRawData() As Byte)

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 49
Chapter 5: API Reference for Visual Basic Developers DPFPReaderDescription

Parameter

aRawData Array of bytes that specifies a deserialized data object

Possible Errors

Error Code Message Description

-2147024809 One or more arguments The format of the data passed to the Deserialize
are invalid. method is incorrect.

Serialize Method
Serializes a data object and returns it as an array of bytes.

Syntax
Dim aRawData As Byte()
aRawData = object.Serialize

Parameter

aRawData Array of bytes that receives a serialized data object

Object Information

Type library DigitalPersona One Touch for Windows Shared components 1.0

Library DPFPShrX.dll

DPFPReaderDescription
The DPFPReaderDescription object provides information about a particular fingerprint reader, such as
its technology or serial number.

Properties

FirmwareRevision Property
Gets the firmware revision number of a fingerprint reader.

Syntax
[ bstrValue = ] DPFPReaderDescription.FirmwareRevision

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 50
Chapter 5: API Reference for Visual Basic Developers DPFPReaderDescription

Possible Values

bstrValue String the receives the fingerprint reader firmware revision number

This property is read-only and has no default value.

HardwareRevision Property
Gets the hardware revision number of a fingerprint reader.

Syntax
[ bstrValue = ] DPFPReaderDescription.HardwareRevision

Possible Values

bstrValue String the receives the fingerprint reader hardware revision number

This property is read-only and has no default value.

Language Property
Gets the fingerprint reader language.

Syntax
[ bstrValue = ] DPFPReaderDescription.get_Language

Possible Values

bstrValue String the receives the fingerprint reader language. The value of bstrValue is
always 0x409, which is English.

This property is read-only and has no default value.

ImpressionType Property
Gets a value that specifies the fingerprint reader impression type, for example, swipe reader or touch (area)
reader.

Syntax
[ enumValue = ] DPFPReaderDescription.ImpressionType

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 51
Chapter 5: API Reference for Visual Basic Developers DPFPReaderDescription

Possible Values

enumValue Enum that receives one of the values from the

DPFPReaderImpressionTypeEnum enumeration (page 68)

This property is read-only and has no default value.

ProductName Property
Gets the product name of a fingerprint reader, for example, “U.are.U.”

Syntax
[ bstrValue = ] DPFPReaderDescription.ProductName

Possible Values

bstrValue String that receives the fingerprint reader product name

This property is read-only and has no default value.

SerialNumber Property
Gets the serial number of a fingerprint reader. This property is read-only and has no default value.

Syntax
[ bstrValue = ] DPFPReaderDescription.SerialNumber

Possible Values

bstrValue String the receives the fingerprint reader serial number

This property is read-only and has no default value.

SerialNumberType Property
Gets a value that specifies the type of fingerprint reader serial number.

Syntax
[ enumValue = ] DPFPReaderDescription.SerialNumberType

Possible Values

enumValue Enum that receives one of the values from the DPFPSerialNumberTypeEnum
enumeration (page 69)

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 52
Chapter 5: API Reference for Visual Basic Developers DPFPReaderDescription

This property is read-only and has no default value.

Technology Property
Gets a value that specifies the fingerprint reader technology.

Syntax
[ enumValue = ] DPFPReaderDescription.Technology

Possible Values

enumValue Enum that receives one of the values from the DPFPReaderTechnologyEnum
enumeration (page 68)

This property is read-only and has no default value.

Vendor Property
Gets the vendor name for a fingerprint reader, for example, “DigitalPersona, Inc.”

Syntax
[ bstrValue = ] DPFPReaderDescription.Vendor

Possible Values

bstrValue String the receives the fingerprint reader vendor name

This property is read-only and has no default value.

Object Information

Type library DigitalPersona One Touch for Windows Device components 1.0
Library DPFPDevX.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 53
Chapter 5: API Reference for Visual Basic Developers DPFPReadersCollection

DPFPReadersCollection
The DPFPReadersCollection object provides information about all of the fingerprint readers connected
to a system.

Method

Reader Method
Returns a DPFPReaderDescription object for a particular fingerprint reader using its serial number.

Syntax
Dim oReader As DPFPReaderDescription
Set oReader = object.Reader(
ByVal bstrReaderSerialNum As String)

Parameters

bstrReaderSerialNumber String that specifies a fingerprint reader serial number

oReader A DPFPReaderDescription object (page 50)

Possible Errors

Error Code Message Description

-2147024894 The system cannot find the The fingerprint reader with the specified serial
specified file. number cannot be found in the system.

Properties

Count Property
Gets the total number of DPFPReaderDescription objects (items) connected to a system (a collection).

Syntax
[ lCount = ] DPFPReadersCollection.Count

Possible Values

lCount Long that receives the total number of DPFPReaderDescription objects

This property is read-only and has no default value.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 54
Chapter 5: API Reference for Visual Basic Developers DPFPReadersCollection

Item Property
Gets or sets a DPFPReaderDescription object (an item) from the fingerprint readers connected to a
system (a collection) using its index.

Syntax
[ lReader = ] DPFPReadersCollection.Item

Possible Values

lReader Long that specifies the index of the DPFPReaderDescription object to

retrieve from the collection. The value of lReader starts with 1.

This property is read-only and has no default value.

Possible Errors

Error Code Message Description

-2147352565 Invalid index. The specified index is not in the valid range from 1 to Count.

_NewEnum Property
Gets a ReaderEnum object (enumeration object), which is an array of DPFPReaderDescription
objects.

Syntax
[ aReaderEnum = ] DPFPReadersCollection._NewEnum

Possible Values

aReaderEnum IUnknown that receives the array of DPFPReaderDescription objects

This property is read-only and has no default value.

Object Information

Type library DigitalPersona One Touch for Windows Device components 1.0

Library DPFPDevX.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 55
Chapter 5: API Reference for Visual Basic Developers DPFPSample

DPFPSample
The DPFPSample object represents a fingerprint sample captured from a fingerprint reader.

Methods

Deserialize Method
Deserializes a data object returned by the Serialize method.

Syntax
object.Deserialize(
ByRef aRawData() As Byte)

Parameter

aRawData Array of bytes that specifies a deserialized data object

Possible Errors

Error Code Message Description

-2147024809 One or more arguments The format of the data passed to the Deserialize
are invalid. method is incorrect.

Serialize Method
Serializes a data object and returns it as an array of bytes.

Syntax
Dim aRawData As Byte()
aRawData = object.Serialize

Parameter

aRawData Array of bytes that receives a serialized data object

Object Information

Type library DigitalPersona One Touch for Windows Shared components 1.0

Library DPFPShrX.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 56
Chapter 5: API Reference for Visual Basic Developers DPFPSampleConversion

See Also
DPFPData on page 40

DPFPSampleConversion
The SampleConversion object provides methods for returning a fingerprint sample as an IPicture
object and as an image in ANSI 381 format.

Methods

ConvertToANSI381 Method
Converts a fingerprint sample to an image in ANSI 381 format.

Dim aAnsi As Byte()

aAnsi = object.ConvertToANSI381(
ByVal oSample As Object)

Parameters

oSample A DPFPSample object (page 56)

vAnsi Variant that receives an image in ANSI 381 format

ConvertToPicture Method
Converts a fingerprint sample to an IPicture object.

Syntax
Dim oPicture As IPictureDisp
Set oPicture = object.ConvertToPicture(
ByVal oSample As Object)

Parameters

oSample A DPFPSample object (page 56)

oPicture An IPicture object

Object Information

Type library DigitalPersona One Touch for Windows Device components 1.0

Library DPFPDevX.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 57
Chapter 5: API Reference for Visual Basic Developers DPFPTemplate

DPFPTemplate
The DPFPTemplate object represents a fingerprint template.

Methods

Deserialize Method
Deserializes a data object returned by the Serialize method.

Syntax
object.Deserialize(
ByRef aRawData() As Byte)

Parameter

aRawData Array of bytes that specifies a deserialized data object

Possible Errors

Error Code Message Description

-2147024809 One or more arguments The format of the data passed to the Deserialize
are invalid. method is incorrect.

Serialize Method
Serializes a data object and returns it as an array of bytes.

Syntax
Dim aRawData As Byte()
aRawData = object.Serialize

Parameter

aRawData Array of bytes that receives a serialized data object

Object Information

Type library DigitalPersona One Touch for Windows Shared components 1.0

Library DPFPShrX.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 58
Chapter 5: API Reference for Visual Basic Developers DPFPVerification

DPFPVerification
The DPFPVerification object performs the system function of fingerprint verification, which is a one-to-
one comparison of a fingerprint feature set with a fingerprint template produced at enrollment that returns a
decision of match or non-match.

Method

Verify Method
Performs the system function of fingerprint verification and specifies a comparison decision based on the
requested FAR set by the FARRequested property.

Syntax
Dim oVerificationResult As DPFPVerificationResult
Set oVerificationResult = object.Verify(
ByVal oVerificationFeatureSet As Object,
ByVal oFingerprintTemplate As Object)

Parameters

oFeatureSet A DPFPFeatureSet object, where the enumPurpose parameter of

the CreateFeatureSet method of the
DPFPFeatureExtraction object was set to the value
DataPurposeVerification (page 48)

oTemplate A DPFPTemplate object (page 58)

oVerificationResult A DPFPVerificationResult object (page 62)

Properties

FARRequested Property
Gets or sets the requested false accept rate (FAR). For more information about the FAR, see False Positives and
False Negatives on page 19.

IMPORTANT: Although the default value is adequate for most applications, you might require a lower or
higher value to meet your needs. If you decide to use a value other than the default, be sure that
you understand the consequences of doing so. Refer to Appendix A on page 132 for more
information about setting the value of the FAR.

Syntax
DPFPVerification.FARRequested [ = lValue ]
[ lValue = ] DPFPVerification.FARRequested

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 59
Chapter 5: API Reference for Visual Basic Developers DPFPVerificationControl

Possible Values

lValue Long that specifies or receives the value of the requested FAR

This optional property is read/write. If you do not set it, the default value is used. You can use the
FARRequested property accessor function to check or to modify the current value of the FAR.

Possible Errors

Error Code Message Description

-2147352566 Out of present range. The data pointed to by the output parameter is
outside the range of possible values.

Object Information

Type library DigitalPersona One Touch for Windows Engine components 1.0

Library DPFPEngX.dll

See Also
DPFPVerificationResult on page 62

DPFPVerificationControl
The DPFPVerificationControl object is an ActiveX control that implements a user interface (described
in DPFPEnrollmentControl Object User Interface on page 116) and provides the following functionality:
„ Receives fingerprint reader connect and disconnect event notifications
„ Captures fingerprint samples from a fingerprint reader(s)
„ Creates fingerprint feature sets for the purpose of verification
„ Fires an event

Property

ReaderSerialNumber Property
Gets or sets the serial number of the fingerprint reader from which a fingerprint sample is captured.

Syntax
DPFPVerificationControl.ReaderSerialNumber [ = bstrValue ]
[ bstrValue = ] DPFPVerificationControl.ReaderSerialNumber

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 60
Chapter 5: API Reference for Visual Basic Developers DPFPVerificationControl

Possible Values

bstrValue String that specifies or receives the fingerprint reader serial number

This optional value is read/write. If you do not set it, the following value is used:
{00000000-0000-0000-0000-000000000000}. This means that the application will receive events
from any of the fingerprint readers attached to the system.

Possible Errors

Error Code Message Description

-2147024809 One or more arguments The format of the string containing the fingerprint
are invalid. reader serial number is incorrect. It should be in GUID
format, for example, {A9EFB3F6-A8C8-4684-841E-
4330973057C6}.

Object Information

Type library DigitalPersona One Touch for Windows Control 1.0

Library DPFPCtlX.dll

Event

OnComplete Event
Fires when a fingerprint feature set created for the purpose of verification is ready for comparison and returns
the fingerprint feature set. The application handles the comparison of the fingerprint feature set with a
fingerprint template.

Syntax
Private Sub object_OnComplete(
ByVal oVerificationFeatureSet As Object,
ByVal oStatus As Object)

Parameters

oVerificationFeatureSet A DPFPFeatureSet object, which represents a fingerprint

feature set created for the purpose of verification (page 49)

oStatus A DPFPEventHandlerStatus object (page 47)

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 61
Chapter 5: API Reference for Visual Basic Developers DPFPVerificationResult

DPFPVerificationResult
The DPFPVerificationResult object represents the results of a fingerprint verification operation.

Properties

FARAchieved Property
Gets the value of the achieved FAR for a comparison operation.

Syntax
[ lValue = ] DPFPVerificationResult.FARAchieved

Possible Values

lValue Long that receives the value of the FAR that was achieved for the comparison

This property is read-only and has no default value. See Achieved FAR on page 134 for more information
about this property.

Verified Property
Gets the comparison decision, which indicates whether the comparison of a fingerprint feature set and a
fingerprint template resulted in a decision of match or non-match. This decision is based on the value of the
FARRequested property of the DPFPVerification object (page 59).

Syntax
[ vbValue = ] DPFPVerificationResult.Verified

Possible Values

vbValue Variant of type boolean that receives the comparison decision. Possible values
are true for a decision of match or false for a decision of non-match.

This property is read-only and has no default value.

Object Information

Type library DigitalPersona One Touch for Windows Engine components 1.0

Library DPFPEngX.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 62
Chapter 5: API Reference for Visual Basic Developers Enumerations

Enumerations
The One Touch for Windows: COM/ActiveX Edition API COM implementation includes the enumerations
defined in this section. Use the following list to quickly locate an enumeration by name, by page number, or by
description.

Method Page Description

DPFPCaptureFeedbackEnum 64 Events returned by a fingerprint reader that provide feedback

about a fingerprint sample capture operation

DPFPCapturePriorityEnum 65 Priority of a fingerprint sample capture operation

DPFPEventHandlerStatusEnum 66 Codes that are returned by the DPFPEventHandlerStatus

object to indicate the status of an operation

DPFPDataPurposeEnum 67 Purpose for which a fingerprint feature set is to be used

DPFPReaderImpressionTypeEnum 68 Modality that a fingerprint reader uses to capture fingerprint

samples

DPFPReaderTechnologyEnum 68 Fingerprint reader technology

DPFPSerialNumberTypeEnum 69 Fingerprint reader serial number persistence after reboot

DPFPTemplateStatusEnum 70 Status of a fingerprint template creation operation

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 63
Chapter 5: API Reference for Visual Basic Developers DPFPCaptureFeedbackEnum Enumeration

DPFPCaptureFeedbackEnum Enumeration
The DPFPCaptureFeedbackEnum enumeration defines the events returned by a fingerprint reader that
provide feedback about a fingerprint sample capture operation.

Syntax
Enum DPFPCaptureFeedbackEnum{
CaptureFeedbackGood = 0,
CaptureFeedbackNone = 1,
CaptureFeedbackTooLight = 2,
CaptureFeedbackTooDark = 3,
CaptureFeedbackTooNoisy = 4,
CaptureFeedbackLowContrast = 5,
CaptureFeedbackNotEnoughFtrs = 6,
CaptureFeedbackNoCentralRgn = 7,
CaptureFeedbackNoFinger = 8,
CaptureFeedbackTooHigh = 9,
CaptureFeedbackTooLow = 10,
CaptureFeedbackTooLeft = 11,
CaptureFeedbackTooRight = 12,
CaptureFeedbackTooStrange = 13,
CaptureFeedbackTooFast = 14,
CaptureFeedbackTooSkewed = 15,
CaptureFeedbackTooShort = 16,
CaptureFeedbackTooSlow = 17,
End Enum

Constants

CaptureFeedbackGood The fingerprint sample is of good quality.

CaptureFeedbackNone There is no fingerprint sample.

CaptureFeedbackTooLight The fingerprint sample is too light.

CaptureFeedbackTooDark The fingerprint sample is too dark

CaptureFeedbackTooNoisy The fingerprint sample is too noisy.

CaptureFeedbackLowContrast The fingerprint sample contrast is too low.

CaptureFeedbackNotEnoughFtrs The fingerprint sample does not contain enough

information.

CaptureFeedbackNoCentralRgn The fingerprint sample is not centered.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 64
Chapter 5: API Reference for Visual Basic Developers DPFPCapturePriorityEnum Enumeration

CaptureFeedbackNoFinger The scanned object is not a finger.

CaptureFeedbackTooHigh The finger was too high on the swipe sensor.

CaptureFeedbackTooLow The finger was too low on the swipe sensor.

CaptureFeedbackTooLeft The finger was too close to the left border of the swipe
sensor.
CaptureFeedbackTooRight The finger was too close to the right border of the swipe
sensor.

CaptureFeedbackTooStrange The scan looks strange.

CaptureFeedbackTooFast The finger was swiped too quickly.

CaptureFeedbackTooSkewed The fingerprint sample is too skewed.

CaptureFeedbackTooShort The fingerprint sample is too short.

CaptureFeedbackTooSlow The finger was swiped too slowly.

Remarks
The members of this enumeration are called by the CreateFeatureSet method of the
DPFPFeatureExtraction object (page 48) and by the OnSampleQuality event of the
DPFPCapture object (page 39).

Enumeration Information

Type library DigitalPersona One Touch for Windows Shared components 1.0

Library DPFPShrX.dll

DPFPCapturePriorityEnum Enumeration
The DPFPCapturePriorityEnum enumeration defines the priority of a fingerprint sample capture
operation performed by a fingerprint reader.

Syntax
Enum DPFPCapturePriorityEnum{
CapturePriorityLow = 0,
CapturePriorityNormal = 1,
CapturePriorityHigh = 2,
End Enum

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 65
Chapter 5: API Reference for Visual Basic Developers DPFPEventHandlerStatusEnum Enumeration

Constants

CapturePriorityLow Low priority. An application uses this priority to acquire events from
the fingerprint reader only if there are no subscribers with high or
normal priority. Only one subscriber with this priority is allowed.

CapturePriorityNormal Normal priority. An application uses this priority to acquire events

from the fingerprint reader only if the operation runs in a foreground
process. Multiple subscribers with this priority are allowed.

CapturePriorityHigh High priority. A subscriber uses this priority to acquire events from the
fingerprint reader exclusively. Only one subscriber with this priority is
allowed.

Remarks
The members of this enumeration are called by the Priority property of the DPFPCapture object
(page 36).

Enumeration Information

Type library DigitalPersona One Touch for Windows Device components 1.0

Library DPFPDevX.dll

DPFPEventHandlerStatusEnum Enumeration
The DPFPEventHandlerStatusEnum enumeration defines the codes that are returned by the
DPFPEventHandlerStatus object to indicate the status of an operation.

Syntax
Enum DPFPEventHandlerStatusEnum{
EventHandlerStatusSuccess = 0,
EventHandlerStatusFailure = 1,
End Enum

Constants

EventHandlerStatusSuccess An operation was performed successfully.

EventHandlerStatusFailure An operation failed.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 66
Chapter 5: API Reference for Visual Basic Developers DPFPDataPurposeEnum Enumeration

Remarks
The members of this enumeration are called by the Status property of the
DPFPEventHandlerStatus object (page 47).

Enumeration Information

Type library DigitalPersona One Touch for Windows Control 1.0

Library DPFPShrX.dll

DPFPDataPurposeEnum Enumeration
The DPFPDataPurposeEnum enumeration defines the purpose for which a fingerprint feature set is to be
used.

Syntax
Enum DPFPDataPurposeEnum{
DataPurposeUnknown = 0,
DataPurposeVerification = 1,
DataPurposeEnrollment = 2,
End Enum

Constants

DataPurposeUnknown The purpose is not known.

DataPurposeVerification A fingerprint feature set to be used for the purpose of verification.

DataPurposeEnrollment A fingerprint feature set to be used for the purpose of enrollment.

Remarks
The members of this enumeration are called by the CreateFeatureSet method of the
DPFPFeatureExtraction object (page 48).

Enumeration Information

Type library DigitalPersona One Touch for Windows Engine components 1.0

Library DPFPEngX.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 67
Chapter 5: API Reference for Visual Basic Developers DPFPReaderImpressionTypeEnum Enumeration

DPFPReaderImpressionTypeEnum Enumeration
The DPFPReaderImpressionTypeEnum enumeration defines the modality that a fingerprint reader uses
to capture fingerprint samples.

Syntax
Enum DPFPReaderImpressionTypeEnum{
ReaderImpressionTypeUnknown = 0,
ReaderImpressionTypeSwipe = 1,
ReaderImpressionTypeArea = 2,
End Enum

Constants

ReaderImpressionTypeUnknown A fingerprint reader for which the modality is not known.

ReaderImpressionTypeSwipe A swipe fingerprint reader.

ReaderImpressionTypeArea An area (touch) sensor fingerprint reader.

Remarks
The members of this enumeration are called by the ImpressionType property of the
DPFPReaderDescription object (page 51).

Enumeration Information

Type library DigitalPersona One Touch for Windows Device components 1.0

Library DPFPDevX.dll

DPFPReaderTechnologyEnum Enumeration
The DPFPReaderTechnologyEnum enumeration defines the fingerprint reader technology.

Syntax
Enum DPFPReaderTechnologyEnum{
ReaderTechnologyUnknown = 0,
ReaderTechnologyOptical = 1,
ReaderTechnologyCapacitive = 2,
ReaderTechnologyThermal = 3,
ReaderTechnologyPressure = 4,
End Enum

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 68
Chapter 5: API Reference for Visual Basic Developers DPFPSerialNumberTypeEnum Enumeration

Constants

ReaderTechnologyUnknown A fingerprint reader for which the technology is not known.

ReaderTechnologyOptical An optical fingerprint reader.

ReaderTechnologyCapacitive A capacitive fingerprint reader.

ReaderTechnologyThermal A thermal fingerprint reader.

ReaderTechnologyPressure A pressure fingerprint reader.

Remarks
The members of this enumeration are called by the Technology property of the
DPFPReaderDescription object (page 53).

Enumeration Information

Type library DigitalPersona One Touch for Windows Device components 1.0

Library DPFPDevX.dll

DPFPSerialNumberTypeEnum Enumeration
The DPFPSerialNumberTypeEnum enumeration defines whether a fingerprint reader serial number
persists after reboot.

Syntax
Enum DPFPSerialNumberTypeEnum{
SerialNumberTypePersistent = 0,
SerialNumberTypeVolatile = 1,
End Enum

Constants

SerialNumberTypePersistent A persistent serial number provided by the hardware.

SerialNumberTypeVolatile A volatile serial number provided by the software.

Remarks
The members of this enumeration are called by the SerialNumberType property of the
DPFPReaderDescription object (page 52).

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 69
Chapter 5: API Reference for Visual Basic Developers DPFPTemplateStatusEnum Enumeration

Enumeration Information

Type library DigitalPersona One Touch for Windows Device components 1.0

Library DPFPDevX.dll

DPFPTemplateStatusEnum Enumeration
The DPFPTemplateStatusEnum enumeration defines the status of a fingerprint template creation
operation.

Syntax
Enum DPFPTemplateStatusEnum{
TemplateStatusUnknown = 0,
TemplateStatusInsufficient = 1,
TemplateStatusFailed = 2,
TemplateStatusReady = 3,
End Enum

Constants

TemplateStatusUnknown The status of a template creation operation is not know,

probably because a fingerprint template does not exist yet.
TemplateStatusInsufficient A fingerprint template exists, but more fingerprint feature sets
are required to complete it.

TemplateStatusFailed A fingerprint template creation operation failed.

TemplateStatusReady A fingerprint template was created and is ready for use.

Remarks
The members of this enumeration are called by the TemplateStatus property of the
DPFPEnrollment object (page 42).

Enumeration Information

Type library DigitalPersona One Touch for Windows Engine components 1.0

Library DPFPEngX.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 70
API Reference for C++ Developers 6

This chapter defines the API components that are used for developing applications that incorporate the
functionality of the One Touch for Windows: COM/ActiveX Edition API in C++ using the Component Object
Model (COM) implementation.

Interfaces
The One Touch for Windows: COM/ActiveX Edition API COM implementation includes the dual, nonextensible
interfaces defined in this section. Use the following list to quickly locate an interface by name, by page number,
or by description.

IMPORTANT: All of the read/write properties of the One Touch for Windows SDK API interfaces are optional. If
you do not set one of these properties, the default value is automatically used. When deciding
whether to set a property, be aware that DigitalPersona may change the default values at any
time without notice. If you want your application’s functionality to remain consistent, you
should set the properties accordingly.

Interface Page Description

IDPFPCapture 73 Used by an application to capture a fingerprint sample from

a fingerprint reader

_IDPFPCaptureEvents 76 Designates an event sink interface that an application must

implement to receive event notifications from a
DPFPCapture object

IDPFPData 78 Represents the functionality of the data that is common to

all fingerprint data objects

IDPFPEnrollment 80 Used by an application to perform the system function of

fingerprint enrollment

IDPFPEnrollmentControl 82 Represents the functionality of an ActiveX control for

performing fingerprint enrollment operations, and provides
a user interface

_IDPFPEnrollmentControlEvents 85 Designates an event sink interface that an application must

implement to receive event notifications from a
DPFPEnrollmentControl object

IDPFPEventHandlerStatus 87 Used by an application to retrieve codes that indicate the

status of an operation

IDPFPFeatureExtraction 88 Used by an application to perform the system function of

fingerprint feature extraction

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 71
Chapter 6: API Reference for C++ Developers Interfaces

Interface Page Description

IDPFPFeatureSet 90 Represents the functionality of a fingerprint feature set

IDPFPReaderDescription 91 Used by an application to obtain information about a

particular fingerprint reader connected to a system

IDPFPReadersCollection 95 Represents a collection of fingerprint readers connected to

a system

IDPFPSample 98 Represents the functionality of a fingerprint sample

IDPFPSampleConversion 99 Used by an application to return a fingerprint sample as an

image

IDPFPTemplate 101 Represents the functionality of a fingerprint template

IDPFPVerification 102 Used by an application to perform fingerprint verification

IDPFPVerificationControl 104 Represents the functionality of an ActiveX control for

creating and returning a fingerprint feature set, and
provides a user interface

_IDPFPVerificationControlEvents 106 Designates an event sink interface that an application must

implement to receive event notifications from a
DPFPVerificationControl object

IDPFPVerificationResult 106 Represents the functionality of the results of a fingerprint

verification operation

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 72
Chapter 6: API Reference for C++ Developers IDPFPCapture Interface

IDPFPCapture Interface
Used by an application to capture a fingerprint sample from a fingerprint reader. The IDPFPCapture
interface provides methods and properties for capturing a fingerprint sample from a fingerprint reader.

IDPFPCapture Members

IDPFPCapture::Priority Property
Retrieves or returns a value that specifies the priority of a fingerprint sample capture operation.

This property is optional. If you do not set it, the value CapturePriorityNormal is used.

Syntax
HRESULT IDPFPCapture::get_Priority(
[out, retval] DPFPCapturePriorityEnum* pVal
);
HRESULT IDPFPCapture::put_Priority(
[in] DPFPCapturePriorityEnum newVal
);

Parameters

pVal [out, retval] Pointer to a variable that receives a value that specifies the priority of a
fingerprint reader sample capture operation. For possible values, see
DPFPCapturePriorityEnum on page 110.

newVal [in] Variable that contains the value that specifies the priority of a fingerprint
reader sample capture operation

Return Values
Returns S_OK if successful, or the following error value otherwise:

Return Value Message Description

DISP_E_OVERFLOW Out of present range. The data pointed to by the output parameter is
outside the range of possible values.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 73
Chapter 6: API Reference for C++ Developers IDPFPCapture Interface

IDPFPCapture::ReaderSerialNumber Property
Retrieves or returns the serial number of a fingerprint reader that captures a fingerprint sample.

This property is optional. If you do not set it, the following value is used:
{00000000-0000-0000-0000-000000000000}. This means that the application will receive events
from any of the fingerprint readers attached to the system.

Syntax
HRESULT IDPFPCapture::get_ReaderSerialNumber(
[out, retval] BSTR* pVal
);
HRESULT IDPFPCapture::put_ReaderSerialNumber(
[in] BSTR newVal
);

Parameters

pVal [out, retval] Pointer to a variable of type BSTR that receives a fingerprint reader
serial number

newVal [in] Variable of type BSTR that contains the fingerprint reader serial number

Return Values
Returns S_OK if successful, or the following error value otherwise:

Return Value Message Description

E_INVALIDARG One or more arguments The format of the string containing the fingerprint
are invalid. reader serial number is incorrect. It should be in
GUID format, for example, {A9EFB3F6-A8C8-4684-
841E-4330973057C6}.

IDPFPCapture::StartCapture Method
Begins capturing a fingerprint sample from a fingerprint reader. A call to this method is asynchronous and
returns immediately. The application continues to receive events until the
IDPFPCapture::StopCapture method is called or when the DPFPCapture object is destroyed.

Syntax
HRESULT StartCapture(void);

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 74
Chapter 6: API Reference for C++ Developers IDPFPCapture Interface

Return Values
Returns S_OK if successful, or the following error value otherwise:

Return Value Message Description

E_INVALIDARG One or more arguments A capture operation with the specified priority
are invalid. already exists. See
DPFPCapturePriorityEnum on page 110 for
more information.

E_ACCESSDENIED General access denied The application does not have sufficient privileges
error. to start capture operations with the specified
priority. See DPFPCapturePriorityEnum on
page 110 for more information.

IDPFPCapture::StopCapture Method
Stops the fingerprint sample capture operation started with a call to the IDPFPCapture::StartCapture
method.

Syntax
HRESULT StopCapture(void);

Return Value
Returns S_OK if successful.

Interface Information

Custom implementation Yes

Inherits from IDispatch

Type library DigitalPersona One Touch for Windows Device components 1.0

Library DPFPDevX.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 75
Chapter 6: API Reference for C++ Developers _IDPFPCaptureEvents Interface

_IDPFPCaptureEvents Interface
Designates an event sink interface that an application must implement to receive event notifications from a
DPFPCapture object, which implements the IDPFPCapture interface (page 73).

_IDPFPCaptureEvents Members

_IDPFPCaptureEvents::OnComplete Event
Fires when a fingerprint sample is successfully captured by a fingerprint reader.

Syntax
HRESULT OnComplete(
[in] BSTR ReaderSerNum,
[in] IDispatch* pFingerprintSample
);

Parameters

ReaderSerNum [in] Variable of type BSTR that contains a fingerprint reader serial
number

pFingerprintSample [in] A DPFPSample object

_IDPFPCaptureEvents::OnFingerGone Event
Fires when a user removes a finger from a fingerprint reader.

Syntax
HRESULT OnFingerGone(
[in] BSTR ReaderSerNum
);

Parameter

ReaderSerNum [in] Variable of type BSTR that contains a fingerprint reader serial number

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 76
Chapter 6: API Reference for C++ Developers _IDPFPCaptureEvents Interface

_IDPFPCaptureEvents::OnFingerTouch Event
Fires when a user touches a fingerprint reader.

Syntax
HRESULT OnFingerTouch(
[in] BSTR ReaderSerNum
);

Parameter

ReaderSerNum [in] Variable of type BSTR that contains a fingerprint reader serial number

_IDPFPCaptureEvents::OnReaderConnect Event
Fires when a fingerprint reader is attached to a system.

Syntax
HRESULT OnReaderConnect(
[in] BSTR ReaderSerNum
);

Parameter

ReaderSerNum [in] Variable of type BSTR that contains a fingerprint reader serial number

_IDPFPCaptureEvents::OnReaderDisconnect Event
Fires when a fingerprint reader is disconnected from a system.

Syntax
HRESULT OnReaderDisconnect(
[in] BSTR ReaderSerNum
);

Parameter

ReaderSerNum [in] Variable of type BSTR that contains a fingerprint reader serial number

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 77
Chapter 6: API Reference for C++ Developers IDPFPData Interface

_IDPFPCaptureEvents::OnSampleQuality Event
Fires when the quality of a fingerprint sample is verified. When SampleQualityGood is returned by this
event, the _IDPFPCaptureEvents::OnComplete event is fired (page 76).

Syntax
HRESULT OnSampleQuality(
[in] BSTR ReaderSerNum,
[in] DPFPCaptureFeedbackEnum SampleQuality
);

Parameters

ReaderSerNum [in] Variable of type BSTR that contains a fingerprint reader serial number

SampleQuality [in] Variable that contains a value that provides feedback about a fingerprint
sample capture operation. For possible values, see
DPFPCaptureFeedbackEnum on page 109.

IDPFPData Interface
Represents the functionality of the data that is common to all fingerprint data objects. The IDPFPData
interface also provides methods to serialize and deserialize fingerprint data objects.

IDPFPData Members

IDPFPData::Deserialize Method
Deserializes a fingerprint data object returned by the IDPFPData::Serialize method.

Syntax
HRESULT Deserialize(
[in] VARIANT RawData
);

Parameter

RawData [in] Variant array of bytes (VT_U1 or VT_ARRAY) that contains a

deserialized fingerprint data object

Return Values
Returns S_OK if successful, or the following error value otherwise:

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 78
Chapter 6: API Reference for C++ Developers IDPFPData Interface

Return Value Message Description

E_INVALIDARG One or more arguments The format of the data passed to the
are invalid. Deserialize method is incorrect.

S_FALSE Feature sets cannot be added because the

fingerprint template has already been created.

IDPFPData::Serialize Method
Serializes a fingerprint data object and returns it as an array of bytes.

Syntax
HRESULT Serialize(
[out, retval] VARIANT* pRawData
);

Parameter

pRawData [out, retval] Pointer to a variant array of bytes (VT_U1 or VT_ARRAY) that
receives a serialized fingerprint data object

Return Value
Returns S_OK if successful.

Interface Information

Custom implementation Yes

Inherits from IDispatch

Type library DigitalPersona One Touch for Windows Shared components 1.0

Library DPFPShrX.dll

See Also
IDPFPFeatureSet Interface on page 90
IDPFPSample Interface on page 98
IDPFPTemplate Interface on page 101

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 79
Chapter 6: API Reference for C++ Developers IDPFPEnrollment Interface

IDPFPEnrollment Interface
Used by an application to perform the system function of fingerprint enrollment. The IDPFPEnrollment
interface provides methods and properties for creating a fingerprint template from a specified number of
fingerprint feature sets created for the purpose of enrollment.

IDPFPEnrollment Members

IDPFPEnrollment::AddFeatures Method
Adds fingerprint feature sets, one-by-one, to a fingerprint template. A call to this method creates an instance of
DPFPTemplate, which represents a fingerprint template. The DPFPTemplate object implements the
IDPFPTemplate interface (page 101). The fingerprint template is complete when the TemplateStatus
property is set to the value TemplateStatusReady.

Syntax
HRESULT AddFeatures(
[in] IDispatch* pVal
);

Parameter

pVal [in] A DPFPFeatureSet object

Return Value
Returns S_OK if successful.

IDPFPEnrollment::Clear Method
Clears a fingerprint template and sets the value of the TemplateStatus property to
TemplateStatusUnknown so an application can begin another fingerprint template creation operation.

Syntax
HRESULT Clear(void);

Return Value
Returns S_OK if successful.

IDPFPEnrollment::FeaturesNeeded Property
Retrieves the number of fingerprint feature sets still needed to create a fingerprint template. When the value of
the pVal parameter is equal to 0, the fingerprint template is created. This property is read-only and has no
default value.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 80
Chapter 6: API Reference for C++ Developers IDPFPEnrollment Interface

Syntax
HRESULT IDPFPEnrollment::get_FeaturesNeeded(
[out, retval] LONG* pVal
);

Parameter

pVal [out, retval] Pointer to a variable of type long that receives the value of the
number of fingerprint feature sets

Return Value
Returns S_OK if successful.

IDPFPEnrollment::Template Property
Retrieves a DPFPTemplate object created during a fingerprint enrollment operation. This property is read-
only and has no default value.

Syntax
HRESULT IDPFPEnrollment::get_Template(
[out, retval] IDispatch** pVal
);

Parameter

pVal [out, retval] A DPFPTemplate object

Return Value
Returns S_OK if successful.

IDPFPEnrollment::TemplateStatus Property
Retrieves a value that specifies the status of a fingerprint template creation operation. This property is read-
only and has no default value.

Syntax
HRESULT IDPFPEnrollment::get_TemplateStatus(
[out, retval] DPFPTemplateStatusEnum* pVal
);

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 81
Chapter 6: API Reference for C++ Developers IDPFPEnrollmentControl Interface

Parameter

pVal [out, retval] Pointer to a variable that receives a value that specifies the status of
the fingerprint template creation operation. For possible values, see
DPFPTemplateStatusEnum on page 115.

Return Value
Returns S_OK if successful.

Interface Information

Custom implementation Yes

Inherits from IDispatch

Type library DigitalPersona One Touch for Windows Engine components 1.0

Library DPFPEngX.dll

IDPFPEnrollmentControl Interface
Represents the functionality of an ActiveX control, which implements a user interface (described in
DPFPEnrollmentControl Object User Interface on page 116). The IDPFPEnrollmentControl interface
provides the following functionality:
„ Captures fingerprint samples from a fingerprint reader(s)
„ Creates fingerprint feature sets for the purpose of enrollment
„ Creates fingerprint templates
„ Notifies an application when an enrollee commits to delete a fingerprint template
„ Fires events

IDPFPEnrollmentControl Members

IDPFPEnrollmentControl::EnrolledFingersMask Property
Retrieves or returns the mask representing the user’s enrolled fingerprints. The enrollment mask is a
combination of the values representing a user’s enrolled fingerprints. For example, if a user’s right index
fingerprint and right middle fingerprint are enrolled, the value of this property is 00000000 011000000, or 192.

This property is optional. If you do not set it, the value 0 is used, which means that no fingerprints have been
enrolled.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 82
Chapter 6: API Reference for C++ Developers IDPFPEnrollmentControl Interface

Syntax
HRESULT IDPFPEnrollmentControl::get_EnrolledFingersMask(
[out, retval] LONG* pVal
);
HRESULT IDPFPEnrollmentControl::put_EnrolledFingersMask(
[in] LONG newVal
);

Parameters

pVal [out, retval] Pointer to a variable of type long that receives the value of the
fingerprint mask

newVal [in] Variable of type long that contains the value of the fingerprint mask

Possible Values
All possible values for the enrollment mask are listed in Table 6.

Table 6. Values for the enrollment mask

Finger Binary Representation Integer Representation

Left little finger 000000000 000000001 1

Left ring finger 000000000 000000010 2

Left middle finger 000000000 000000100 4

Left index finger 000000000 000001000 8

Left thumb 000000000 000010000 16

Right thumb 000000000 000100000 32

Right index finger 000000000 001000000 64

Right middle finger 000000000 010000000 128

Right ring finger 000000000 100000000 256

Right little finger 000000001 000000000 512

Return Values
Returns S_OK if successful, or the following error value otherwise:

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 83
Chapter 6: API Reference for C++ Developers IDPFPEnrollmentControl Interface

Return Value Message Description

DISP_E_OVERFLOW Out of present range. The data pointed to by the output parameter is
outside the range of possible values.

IDPFPEnrollmentControl::MaxEnrollFingerCount Property
Retrieves or returns the value for the maximum number of fingerprints that can be enrolled. Possible values for
this parameter are 1 through 10.

This property is optional. If you do not set it, the value 10 is used, which means the user can enroll all ten
fingerprints.

Syntax
HRESULT IDPFPEnrollmentControl::get_MaxEnrollFingerCount(
[out, retval] LONG* pVal
);
HRESULT IDPFPEnrollmentControl::put_MaxEnrollFingerCount(
[in] LONG newVal
);

Parameters

pVal [out, retval] Pointer to a variable of type long that receives the value for the
maximum number of fingerprints that can be enrolled

newVal [in] Variable of type long that contains the value for the maximum number of
fingerprints that can be enrolled

Return Values
Returns S_OK if successful, or the following error value otherwise:

Return Value Message Description

DISP_E_OVERFLOW Out of present range. The data pointed to by the output parameter is
outside the range of possible values.

IDPFPEnrollmentControl::ReaderSerialNumber Property
Retrieves or returns the serial number of the fingerprint reader from which a fingerprint sample is captured.

This property is optional. If you do not set it, the following value is used:
{00000000-0000-0000-0000-000000000000}. This means that the application will receive events
from any of the fingerprint readers attached to the system.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 84
Chapter 6: API Reference for C++ Developers _IDPFPEnrollmentControlEvents Interface

Syntax
HRESULT IDPFPEnrollmentControl::get_ReaderSerialNumber(
[out, retval] BSTR* pVal
);
HRESULT IDPFPEnrollmentControl::put_ReaderSerialNumber(
[in] BSTR newVal
);

Parameters

pVal [out, retval] Pointer to a variable of type BSTR that receives the fingerprint reader
serial number
newVal [in] Variable of type BSTR that contains the fingerprint reader serial number

Return Values
Returns S_OK if successful, or the following error value otherwise:

Return Value Message Description

E_INVALIDARG One or more arguments The format of the string containing the fingerprint
are invalid. reader serial number is incorrect. It should be in
GUID format, for example, {A9EFB3F6-A8C8-4684-
841E-4330973057C6}.

Interface Information

Custom implementation Yes

Inherits from IDispatch

Type library DigitalPersona One Touch for Windows Control 1.0

Library DPFPCtlX.dll

_IDPFPEnrollmentControlEvents Interface
Designates an event sink interface that an application must implement to receive event notifications from a
DPFPEnrollmentControl object, which implements the IDPFPEnrollmentControl interface
(page 82).

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 85
Chapter 6: API Reference for C++ Developers _IDPFPEnrollmentControlEvents Interface

_IDPFPEnrollmentControlEvents Members

_IDPFPEnrollmentControlEvents::OnDelete Event
Fires when a user commits to delete an enrolled fingerprint. The application handles the deletion of the
fingerprint template from a fingerprint data storage subsystem and can display its own success or error
messages.

Syntax
HRESULT OnDelete(
[in] LONG 1FingerMask,
[in] IDispatch* pStatus
);

Parameters

1FingerMask [in] Pointer to a variable of type long that contains the index value of the
(enrolled) fingerprint to be deleted. For possible values, see Table 7.

pStatus [in] A DPFPEventHandlerStatus object

The uFingerMask parameter is the index value of the finger associated with a fingerprint to be enrolled
or a fingerprint template to be deleted, as defined in ANSI/NIST-ITL 1. The index values are assigned to the
graphical representation of the fingers on the hands in the user interface. All possible values are listed in
Table 7.

Table 7. Finger index values in ANSI/NIST-ITL 1

Finger Index Value Finger Index Value

Right thumb 1 Left thumb 6

Right index finger 2 Left index finger 7

Right middle finger 3 Left middle finger 8

Right ring finger 4 Left ring finger 9

Right little finger 5 Left little finger 10

_IDPFPEnrollmentControlEvents::OnEnroll Event
Fires when a user enrolls a fingerprint and returns a fingerprint template. The application handles the storage
of the fingerprint template in a fingerprint data storage subsystem and can display its own success or error
messages.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 86
Chapter 6: API Reference for C++ Developers IDPFPEventHandlerStatus Interface

Syntax
HRESULT OnEnroll(
[in] LONG 1FingerMask,
[in] IDispatch* pFingerprintTemplate,
[in] IDispatch* pStatus
);

Parameters

1FingerMask [in] Variable of type long that contains the index value for the enrolled
fingerprint. For possible values, see Table 7 on page 86.

pFingerprintTemplate [in] A DPFPTemplate object

pStatus [in] A DPFPEventHandlerStatus object

IDPFPEventHandlerStatus Interface
Used by an application to retrieve codes that indicate the status of an operation.

IDPFPEventHandlerStatus Member

IDPFPEventHandlerStatus::Status Property
Retrieves or returns the status of an operation performed by a DPFPEnrollmentControl object, which
implements the IDPFPEnrollmentControl interface (page 82), or a DPFPVerificationControl
object, which implements the IDPFPVerificationControl interface (page 104).

This property is optional. If you do not set it, the value DPFPEventHandlerStatusSuccess is used.

Syntax
HRESULT IDPFPEventHandlerStatus::get_Status(
[out, retval] DPFPEventHandlerStatusEnum* pVal
);
HRESULT IDPFPEventHandlerStatus::put_Status(
[in] DPFPEventHandlerStatusEnum newVal
);

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 87
Chapter 6: API Reference for C++ Developers IDPFPFeatureExtraction Interface

Parameters

pVal [out, retval] Pointer to a variable that receives a value that indicates the status of an
operation. For possible values, see DPFPEventHandlerStatusEnum on
page 111.

newVal [in] Variable that contains the value that indicates the status of an operation

Return Values
Returns S_OK if successful, or the following error value otherwise:

Return Value Message Description

DISP_E_OVERFLOW Out of present range. The data pointed to by the output parameter is
outside the range of possible values.

Interface Information

Custom implementation Yes

Inherits from IDispatch

Type library DigitalPersona One Touch for Windows Control 1.0

Library DPFPCtlX.dll

IDPFPFeatureExtraction Interface
Used by an application to perform fingerprint feature extraction. The IDPFPFeatureExtraction interface
provides a method and a property for creating a fingerprint feature set for the purpose of enrollment or
verification by applying fingerprint feature extraction to a fingerprint sample.

IDPFPFeatureExtraction Members

IDPFPFeatureExtraction::CreateFeatureSet Method
Applies fingerprint feature extraction to a fingerprint sample and then creates a fingerprint feature set for the
specified purpose. A call to this method creates an instance of DPFPFeatureSet, which represents a
fingerprint feature set. The DPFPFeatureSet object implements the IDPFPFeatureSet interface
(page 90).

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 88
Chapter 6: API Reference for C++ Developers IDPFPFeatureExtraction Interface

Syntax
HRESULT CreateFeatureSet(
[in] IDispatch* pFingerprintSample,
[in] DPFPDataPurposeEnum Purpose,
[out, retval] DPFPCaptureFeedbackEnum* pSampleQuality
);

Parameters

pFingerprintSample [in] A DPFPSample object

Purpose [in] Variable that contains a value for the specified purpose. For possible
values, see DPFPDataPurposeEnum on page 112.

pSampleQuality [out, retval] Pointer to a variable that receives a value that provides
feedback about a fingerprint sample capture operation. For possible
values, see DPFPCaptureFeedbackEnum on page 109.

Return Value
Returns S_OK if successful.

IDPFPFeatureExtraction::FeatureSet Property
Retrieves a DPFPFeatureSet object created during a fingerprint feature extraction operation. This
property is read-only and has no default value.

Syntax
HRESULT IDPFPFeatureExtraction::get_FeatureSet(
[out, retval] IDispatch** pVal
);

Parameter

pVal [out, retval] A DPFPFeatureSet object

Return Values
Returns S_OK if successful, or the following error value otherwise:

Return Value Message Description

DISP_E_MEMBERNOTFOUND Member not found. A fingerprint feature set has not been created
yet.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 89
Chapter 6: API Reference for C++ Developers IDPFPFeatureSet Interface

Interface Information

Custom implementation Yes

Inherits from IDispatch

Type library DigitalPersona One Touch for Windows Engine components 1.0

Library DPFPEngX.dll

IDPFPFeatureSet Interface
Represents the functionality of a fingerprint feature set. A DPFPFeatureSet object, which represents a
fingerprint feature set, implements the IDPFPFeatureSet interface.

IDPFPFeatureSet Members

IDPFPFeatureSet::Deserialize Method
Deserializes a fingerprint data object returned by the IDPFPFeatureSet::Serialize method.

Syntax
HRESULT Deserialize(
[in] VARIANT RawData
);

Parameter

RawData [in] Variant array of bytes (VT_U1 or VT_ARRAY) that contains a

deserialized fingerprint data object

Return Values
Returns S_OK if successful, or the following error value otherwise:

Return Value Message Description

E_INVALIDARG One or more arguments The format of the data passed to the
are invalid. Deserialize method is incorrect.

S_FALSE Feature sets cannot be added because the

fingerprint template has already been created.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 90
Chapter 6: API Reference for C++ Developers IDPFPReaderDescription Interface

IDPFPFeatureSet::Serialize Method
Serializes a fingerprint data object and returns it as an array of bytes.

Syntax
HRESULT Serialize(
[out, retval] VARIANT* pRawData
);

Parameter

pRawData [out, retval] Pointer to a variant array of bytes (VT_U1 or VT_ARRAY) that
receives a serialized fingerprint data object

Return Value
Returns S_OK if successful.

Interface Information

Custom implementation Yes

Inherits from IDPFPData

Type library DigitalPersona One Touch for Windows Shared components 1.0

Library DPFPShrX.dll

IDPFPReaderDescription Interface
Used by an application to obtain information about a particular fingerprint reader connected to a system, such
as its technology or serial number.

IDPFPReaderDescription Members

IDPFPReaderDescription::FirmwareRevision Property
Retrieves the firmware revision number of a fingerprint reader. This property is read-only and has no default
value.

Syntax
HRESULT IDPFPReaderDescription::get_FirmwareRevision(
[out, retval] BSTR* pVal
);

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 91
Chapter 6: API Reference for C++ Developers IDPFPReaderDescription Interface

Parameter

pVal [in] Pointer to a variable of type BSTR the receives the fingerprint reader firmware
revision number

Return Value
Returns S_OK if successful.

IDPFPReaderDescription::HardwareRevision Property
Retrieves the hardware revision number of a fingerprint reader. This property is read-only and has no default
value.

Syntax
HRESULT IDPFPReaderDescription::get_HardwareRevision(
[out, retval] BSTR* pVal
);

Parameter

pVal [in] Pointer to a variable of type BSTR that receives the fingerprint reader
hardware revision number

IDPFPReaderDescription::Language Property
Retrieves the fingerprint reader language. The value of the pVal parameter is always 0x409, which is English.
This property is read-only and has no default value.

Syntax
HRESULT IDPFPReaderDescription::get_Language(
[out, retval] LONG* pVal
);

Parameter

pVal [in] Pointer to a variable of type BSTR that receives the fingerprint reader language

Return Value
Returns S_OK if successful.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 92
Chapter 6: API Reference for C++ Developers IDPFPReaderDescription Interface

IDPFPReaderDescription::ImpressionType Property
Retrieves a value that specifies the fingerprint reader impression type, for example, swipe reader or touch
(area) reader. This property is read-only and has no default value.

Syntax
HRESULT IDPFPReaderDescription::get_ImpressionType(
[out, retval] DPFPReaderImpressionTypeEnum* pVal
);

Parameter

pVal [in] Pointer to a variable that receives a value that specifies the fingerprint reader
modality. For possible values, see DPFPReaderImpressionTypeEnum on
page 113.

Return Value
Returns S_OK if successful.

IDPFPReaderDescription::ProductName Property
Retrieves the product name of a fingerprint reader, for example, “U.are.U.” This property is read-only and has no
default value.

Syntax
HRESULT IDPFPReaderDescription::get_ProductName(
[out, retval] BSTR* pVal
);

Parameter

pVal [in] Pointer to a variable of type BSTR that receives the fingerprint reader product
name

Return Value
Returns S_OK if successful.

IDPFPReaderDescription::SerialNumber Property
Retrieves the serial number of a fingerprint reader. This property is read-only and has no default value.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 93
Chapter 6: API Reference for C++ Developers IDPFPReaderDescription Interface

Syntax
HRESULT IDPFPReaderDescription::get_SerialNumber(
[out, retval] BSTR* pVal
);

Parameter

pVal [in] Pointer to a variable of type BSTR the receives the fingerprint reader serial
number

Return Value
Returns S_OK if successful.

IDPFPReaderDescription::SerialNumberType Property
Retrieves a value that specifies the type of fingerprint reader serial number. This property is read-only and has
no default value.

Syntax
HRESULT IDPFPReaderDescription::get_SerialNumberType(
[out, retval] DPFPSerialNumberTypeEnum* pVal
);

Parameter

pVal [in] Pointer to a variable that receives a value that specifies the fingerprint reader
serial number type. For possible values, see DPFPSerialNumberTypeEnum
on page 114.

Return Value
Returns S_OK if successful.

IDPFPReaderDescription::Technology Property
Retrieves a value that specifies the fingerprint reader technology. This property is read-only and has no default
value.

Syntax
HRESULT IDPFPReaderDescription::get_Technology(
[out, retval] DPFPReaderTechnologyEnum* pVal
);

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 94
Chapter 6: API Reference for C++ Developers IDPFPReadersCollection Interface

Parameter

pVal [in] Pointer to a variable that receives a value that specifies the fingerprint reader
technology. For possible values, see DPFPReaderTechnologyEnum on
page 113.

Return Value
Returns S_OK if successful.

IDPFPReaderDescription::Vendor Property
Retrieves the vendor name for a fingerprint reader, for example, “DigitalPersona, Inc.” This property is read-only
and has no default value.

Syntax
HRESULT IDPFPReaderDescription::get_Vendor(
[out, retval] BSTR* pVal
);

Parameter

pVal [in] Pointer to a variable of type BSTR the receives the fingerprint reader vendor
name

Return Value
Returns S_OK if successful.

Interface Information

Custom implementation Yes

Inherits from IDispatch

Type library DigitalPersona One Touch for Windows Device components 1.0

Library DPFPDevX.dll

IDPFPReadersCollection Interface
Represents a collection of fingerprint readers connected to a system. The IDPFPReadersCollection
interface provides a method and properties for enumerating fingerprint readers, for retrieving a particular
fingerprint reader using its index value or its serial number, and for reporting the total number of fingerprint
readers.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 95
Chapter 6: API Reference for C++ Developers IDPFPReadersCollection Interface

IDPFPReadersCollection Members

IDPFPReadersCollection::Reader Method
Creates an instance of DPFPReaderDescription for a particular fingerprint reader using its serial
number. The DPFPReaderDescription object implements the IDPFPReaderDescription
interface (page 91).

Syntax
HRESULT Reader(
[in] BSTR ReaderSerialNum,
[out,retval] IDispatch** ppReader
);

Parameters

ReaderSerialNumber [in] Variable of type BSTR that contains a fingerprint reader serial number

ppReader [out, retval] A DPFPReaderDescription object

Return Values
Returns S_OK if successful, or the following error value otherwise:

Return Value Message Description

_HRESULT_FROM_WIN32 The system cannot find The fingerprint reader with the
(ERROR_FILE_NOT_FOUND) the specified file. specified serial number cannot be
found in the system.

IDPFPReadersCollection::Count Property
Retrieves the total number of DPFPReaderDescription objects (items) connected to a system (a
collection). This property is read-only and has no default value.

Syntax
HRESULT IDPFPReadersCollection::get_Count(
[out,retval] LONG* pVal
);

Parameter

pVal [in] Pointer to a variable of type long that receives the total number of
DPFPReaderDescription objects

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 96
Chapter 6: API Reference for C++ Developers IDPFPReadersCollection Interface

Return Value
Returns S_OK if successful.

IDPFPReadersCollection::Item Property
Retrieves a DPFPReaderDescription object (an item) from the fingerprint readers connected to a
system (a collection) using its index. The value of the pVal parameter starts with 1.

Syntax
HRESULT IDPFPReadersCollection::get_Item(
[out,retval] IDispatch** pVal
);

Parameter

pVal [out, retval] A DPFPReaderDescription object

Return Values
Returns S_OK if successful, or the following error value otherwise:

Return Value Message Description

DISP_E_BADINDEX Invalid index. The specified index is not in the valid range from 1 to
Count.

IDPFPReadersCollection::_NewEnum Property
Retrieves an IUnknown pointer to the ReaderEnum object (enumeration object), which is an array of
DPFPReaderDescription objects. This property is read-only and has no default value.

Syntax
HRESULT IDPFPReadersCollection::get__NewEnum(
[out,retval] IUnknown** pVal
);

Parameter

pVal [in] Pointer to a variable of type IUnknown that receives the array of
DPFPReaderDescription objects

Return Value
Returns S_OK if successful.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 97
Chapter 6: API Reference for C++ Developers IDPFPSample Interface

Interface Information

Custom implementation Yes

Inherits from IDispatch

Type library DigitalPersona One Touch for Windows Device components 1.0

Library DPFPDevX.dll

IDPFPSample Interface
Represents the functionality of a fingerprint sample captured from a fingerprint reader. A DPFPSample
object, which represents a fingerprint sample, implements the IDPFPSample interface.

IDPFPSample Members

IDPFPSample::Deserialize Method
Deserializes a fingerprint data object returned by the IDPFPSample::Serialize method.

Syntax
HRESULT Deserialize(
[in] VARIANT RawData
);

Parameter

RawData [in] Variant array of bytes (VT_U1 or VT_ARRAY) that contains a

deserialized fingerprint data object

Return Values
Returns S_OK if successful, or the following error value otherwise:

Return Value Message Description

E_INVALIDARG One or more arguments The format of the data passed to the
are invalid. Deserialize method is incorrect.

S_FALSE Feature sets cannot be added because the

fingerprint template has already been created.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 98
Chapter 6: API Reference for C++ Developers IDPFPSampleConversion Interface

IDPFPSample::Serialize Method
Serializes a fingerprint data object and returns it as an array of bytes.

Syntax
HRESULT Serialize(
[out, retval] VARIANT* pRawData
);

Parameter

pRawData [out, retval] Pointer to a variant array of bytes (VT_U1 or VT_ARRAY) that
receives a serialized fingerprint data object

Return Value
Returns S_OK if successful.

Interface Information

Custom implementation Yes

Inherits from IDPFPData

Type library DigitalPersona One Touch for Windows Shared components 1.0

Library DPFPShrX.dll

See Also
IDPFPData Interface on page 78

IDPFPSampleConversion Interface
Used by an application to convert a fingerprint sample to an image. The IDPFPSampleConversion
interface provides methods for returning a fingerprint sample as an IPicture object and as an image in
ANSI 381 format.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 99
Chapter 6: API Reference for C++ Developers IDPFPSampleConversion Interface

IDPFPSampleConversion Members

IDPFPSample::ConvertToANSI381 Method
Converts a fingerprint sample to an image in ANSI 381 format.

HRESULT ConvertToANSI381(
[in] IDispatch* pSample,
[out,retval] VARIANT* pAnsi
);

Parameters

pSample [in] A DPFPSample object

pAnsi [out, retval] Pointer to a variant array of bytes (VT_U1 or VT_ARRAY) that
receives an image in ANSI 381 format

Return Value
Returns S_OK if successful.

IDPFPSample::ConvertToPicture Method
Converts a fingerprint sample to an IPicture object.

Syntax
HRESULT ConvertToPicture(
[in] IDispatch* pSample,
[out,retval] IDispatch** ppPicture
);

Parameters

pSample [in] A DPFPSample object

ppPicture [out, retval] An IPicture object

Return Value
Returns S_OK if successful.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 100
Chapter 6: API Reference for C++ Developers IDPFPTemplate Interface

Interface Information

Custom implementation Yes

Inherits from IDispatch

Type library DigitalPersona One Touch for Windows Device components 1.0

Library DPFPDevX.dll

IDPFPTemplate Interface
Represents the functionality of a fingerprint template. A DPFPTemplate object, which represents a
fingerprint template, implements the IDPFPTemplate interface.

IDPFPTemplate Members

IDPFPTemplate::Deserialize Method
Deserializes a fingerprint data object returned by the IDPFPTemplate::Serialize method.

Syntax
HRESULT Deserialize(
[in] VARIANT RawData
);

Parameter

RawData [in] Variant array of bytes (VT_U1 or VT_ARRAY) that contains a

deserialized fingerprint data object

Return Values
Returns S_OK if successful, or the following error value otherwise:

Return Value Message Description

E_INVALIDARG One or more arguments The format of the data passed to the
are invalid. Deserialize method is incorrect.

S_FALSE Feature sets cannot be added because the

fingerprint template has already been created.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 101
Chapter 6: API Reference for C++ Developers IDPFPVerification Interface

IDPFPTemplate::Serialize Method
Serializes a fingerprint data object and returns it as an array of bytes.

Syntax
HRESULT Serialize(
[out, retval] VARIANT* pRawData
);

Parameter

pRawData [out, retval] Pointer to a variant array of bytes (VT_U1 or VT_ARRAY) that
receives a serialized fingerprint data object

Return Value
Returns S_OK if successful.

Interface Information

Custom implementation Yes

Inherits from IDPFPData

Type library DigitalPersona One Touch for Windows Shared components 1.0

Library DPFPShrX.dll

IDPFPVerification Interface
Used by an application to perform the system function of fingerprint verification. The IDPFPVerification
interface provides a method and a property for performing fingerprint verification, which is a one-to-one
comparison of a fingerprint feature set with a fingerprint template produced at enrollment that returns a
decision of match or non-match.

IDPFPVerification Members

IDPFPVerification::FARRequested Property
Retrieves or returns the requested false accept rate (FAR). For a general explanation of the FAR, see False
Positives and False Negatives on page 19.

This property is optional. If you do not set it, the default value is used. You can use the FARRequested
property to check or to modify the current value of the FAR.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 102
Chapter 6: API Reference for C++ Developers IDPFPVerification Interface

IMPORTANT: Although the default value is adequate for most applications, you might require a lower or
higher value to meet your needs. If you decide to use a value other than the default, be sure that
you understand the consequences of doing so. Refer to Appendix A on page 132 for more
information about setting the value of the FAR.

Syntax
HRESULT IDPFPVerification::get_FARRequested(
[out, retval] LONG* pVal
);
HRESULT IDPFPVerification::put_FARRequested(
[in] LONG newVal
);

Parameters

pVal [out, retval] Pointer to a variable of type long that receives the value of the
requested FAR

newVal [in] Variable of type long that contains the value of the requested FAR

Return Values
Returns S_OK if successful, or the following error value otherwise:

Return Value Message Description

DISP_E_OVERFLOW Out of present range. The data pointed to by the output parameter is
outside the range of possible values.

IDPFPVerification::Verify Method
Performs the system function of fingerprint verification and returns a comparison decision based on the
requested FAR set by the IDPFPVerification::FARRequested property.

Syntax
HRESULT Verify(
[in] IDispatch* pVerificationFeatureSet,
[in] IDispatch* pFingerprintTemplate,
[out, retval] IDispatch** ppVerificationResult
);

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 103
Chapter 6: API Reference for C++ Developers IDPFPVerificationControl Interface

Parameters

pFeatureSet [in] A DPFPFeatureSet object, where the Purpose parameter of

the IDPFPFeatureExtraction::CreateFeatureSet method
was set to the value DataPurposeVerification (page 88)

pTemplate [in] A DPFPTemplate object

ppVerificationResult [out, retval] A DPFPVerificationResult object

Return Value
Returns S_OK if successful.

Interface Information

Custom implementation Yes

Inherits from IDispatch

Type library DigitalPersona One Touch for Windows Engine components 1.0

Library DPFPEngX.dll

See Also
IDPFPVerificationResult Interface on page 106

IDPFPVerificationControl Interface
Represents the functionality of an ActiveX control, which implements a user interface (described in
DPFPEnrollmentControl Object User Interface on page 116). The IDPFPVerificationControl interface
provides the following functionality:
„ Receives fingerprint reader connect and disconnect event notifications
„ Captures fingerprint samples from a fingerprint reader(s)
„ Creates fingerprint feature sets for the purpose of verification
„ Fires an event

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 104
Chapter 6: API Reference for C++ Developers IDPFPVerificationControl Interface

IDPFPVerificationControl Members

IDPFPVerificationControl::ReaderSerialNumber Property
Retrieves or returns the serial number of the fingerprint reader from which a fingerprint sample is captured.

This property is optional. If you do not set it, the following value is used:
{00000000-0000-0000-0000-000000000000}. This means that the application will receive events
from any of the fingerprint readers attached to the system.

Syntax
HRESULT IDPFPVerificationControl::get_ReaderSerialNumber(
[out, retval] BSTR* pVal
);
HRESULT IDPFPVerificationControl::put_ReaderSerialNumber(
[in] BSTR newVal
);

Parameters

pVal [out, retval] Pointer to a variable of type BSTR that receives the fingerprint reader
serial number

newVal [in] Variable of type BSTR that contains the fingerprint reader serial number

Return Values
Returns S_OK if successful, or the following error value otherwise:

Return Value Message Description

E_INVALIDARG One or more arguments The format of the string containing the fingerprint
are invalid. reader serial number is incorrect. It should be in
GUID format, for example, {A9EFB3F6-A8C8-4684-
841E-4330973057C6}.

Interface Information

Custom implementation Yes

Inherits from IDispatch

Type library DigitalPersona One Touch for Windows Control 1.0

Library DPFPCtlX.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 105
Chapter 6: API Reference for C++ Developers _IDPFPVerificationControlEvents Interface

_IDPFPVerificationControlEvents Interface
Designates an event sink interface that an application must implement to receive event notifications from a
DPFPVerificationControl object, which implements the IDPFPVerificationControl interface
(page 104).

_IDPFPVerificationControlEvents Members

_IDPFPVerificationControlEvents::OnComplete Event
Fires when a fingerprint feature set created for the purpose of verification is ready for comparison and returns
the fingerprint feature set. The application handles the comparison of the fingerprint feature set with a
fingerprint template.

Syntax
HRESULT OnComplete(
[in] IDispatch* pVerificationFeatureSet,
[in] IDispatch* pStatus
);

Parameters

pVerificationFeatureSet [in] A DPFPFeatureSet object

pStatus [in] A DPFPEventHandlerStatus object

Return Value
Returns S_OK if successful.

IDPFPVerificationResult Interface
Represents the functionality of the results of a fingerprint verification operation. A
DPFPVerificationResult object, which represents the results of a fingerprint verification operation,
implements the IDPFPVerificationResult interface. The IDPFPVerificationResult interface
provides properties for retrieving the results of a fingerprint verification operation.

IDPFPVerificationResult Members

IDPFPVerificationResult::FARAchieved Property
Retrieves the value of the achieved FAR for a comparison operation. This property is read-only and has no
default value. See Achieved FAR on page 134 for more information about this property.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 106
Chapter 6: API Reference for C++ Developers IDPFPVerificationResult Interface

Syntax
HRESULT IDPFPVerificationResult::get_FARAchieved(
[out, retval] LONG* pVal
);

Parameter

pVal [out, retval] Pointer to a variable of type long that receives the value of the FAR
that was achieved for the comparison

Return Value
Returns S_OK if successful.

IDPFPVerificationResult::Verified Property
Retrieves the comparison decision, which indicates whether the comparison of a fingerprint feature set and a
fingerprint template resulted in a decision of match or non-match. This decision is based on the value set by
the IDPFPVerification::FARRequested property (page 102). The
IDPFPVerificationResult::Verified property is read-only and has no default value.

Syntax
HRESULT IDPFPVerificationResult::get_Verified(
[out, retval] VARIANT_BOOL* pVal
);

Parameter

pVal [out, retval] Pointer to a variant of type boolean that receives the comparison
decision. Possible values are true for a decision of match or false for a decision of
non-match.

Return Value
Returns S_OK if successful.

Interface Information

Custom implementation Yes

Inherits from IDispatch

Type library DigitalPersona One Touch for Windows Engine components 1.0
Library DPFPEngX.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 107
Chapter 6: API Reference for C++ Developers Enumerations

Enumerations
The One Touch for Windows: COM/ActiveX Edition API COM implementation includes the enumerated types
defined in this section. Use the following list to quickly locate an enumerated type by name, by page number,
or by description.

Method Page Description

DPFPCaptureFeedbackEnum 109 Events returned by a fingerprint reader that provide feedback

about a fingerprint sample capture operation

DPFPCapturePriorityEnum 110 Priority of a fingerprint sample capture operation

DPFPEventHandlerStatusEnum 111 Codes that are returned by the DPFPEventHandlerStatus

object to indicate the status of an operation

DPFPDataPurposeEnum 112 Purpose for which a fingerprint feature set is to be used

DPFPReaderImpressionTypeEnum 113 Modality that a fingerprint reader uses to capture fingerprint

samples

DPFPReaderTechnologyEnum 113 Fingerprint reader technology

DPFPSerialNumberTypeEnum 114 Fingerprint reader serial number persistence after reboot

DPFPTemplateStatusEnum 115 Status of a fingerprint template creation operation

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 108
Chapter 6: API Reference for C++ Developers DPFPCaptureFeedbackEnum Enumerated Type

DPFPCaptureFeedbackEnum Enumerated Type

The DPFPCaptureFeedbackEnum enumerated type defines the events returned by a fingerprint reader
that provide feedback about a fingerprint sample capture operation.

Syntax
typedef enum DPFPCaptureFeedbackEnum{
CaptureFeedbackGood = 0,
CaptureFeedbackNone = 1,
CaptureFeedbackTooLight = 2,
CaptureFeedbackTooDark = 3,
CaptureFeedbackTooNoisy = 4,
CaptureFeedbackLowContrast = 5,
CaptureFeedbackNotEnoughFtrs = 6,
CaptureFeedbackNoCentralRgn = 7,
CaptureFeedbackNoFinger = 8,
CaptureFeedbackTooHigh = 9,
CaptureFeedbackTooLow = 10,
CaptureFeedbackTooLeft = 11,
CaptureFeedbackTooRight = 12,
CaptureFeedbackTooStrange = 13,
CaptureFeedbackTooFast = 14,
CaptureFeedbackTooSkewed = 15,
CaptureFeedbackTooShort = 16,
CaptureFeedbackTooSlow = 17,
} DPFPCaptureFeedbackEnum;

Constants

CaptureFeedbackGood The fingerprint sample is of good quality.

CaptureFeedbackNone There is no fingerprint sample.

CaptureFeedbackTooLight The fingerprint sample is too light.

CaptureFeedbackTooDark The fingerprint sample is too dark

CaptureFeedbackTooNoisy The fingerprint sample is too noisy.

CaptureFeedbackLowContrast The fingerprint sample contrast is too low.

CaptureFeedbackNotEnoughFtrs The fingerprint sample does not contain enough

information.

CaptureFeedbackNoCentralRgn The fingerprint sample is not centered.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 109
Chapter 6: API Reference for C++ Developers DPFPCapturePriorityEnum Enumerated Type

CaptureFeedbackNoFinger The scanned object is not a finger.

CaptureFeedbackTooHigh The finger was too high on the swipe sensor.

CaptureFeedbackTooLow The finger was too low on the swipe sensor.

CaptureFeedbackTooLeft The finger was too close to the left border of the swipe
sensor.
CaptureFeedbackTooRight The finger was too close to the right border of the swipe
sensor.

CaptureFeedbackTooStrange The scan looks strange.

CaptureFeedbackTooFast The finger was swiped too quickly.

CaptureFeedbackTooSkewed The fingerprint sample is too skewed.

CaptureFeedbackTooShort The fingerprint sample is too short.

CaptureFeedbackTooSlow The finger was swiped too slowly.

Remarks
The members of this enumerated type are called by the
IDPFPFeatureExtraction::CreateFeatureSet method (page 88) and by the
_IDPFPCaptureEvents::OnSampleQuality event (page 78).

Enumerated Type Information

Type library DigitalPersona One Touch for Windows Shared components 1.0

Library DPFPShrX.dll

DPFPCapturePriorityEnum Enumerated Type

The DPFPCapturePriorityEnum enumerated type defines the priority of a fingerprint sample capture
operation performed by a fingerprint reader.

Syntax
typedef enum DPFPCapturePriorityEnum{
CapturePriorityLow = 0,
CapturePriorityNormal = 1,
CapturePriorityHigh = 2,
} DPFPCapturePriorityEnum;

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 110
Chapter 6: API Reference for C++ Developers DPFPEventHandlerStatusEnum Enumerated Type

Constants

CapturePriorityLow Low priority. An application uses this priority to acquire events from
the fingerprint reader only if there are no subscribers with high or
normal priority. Only one subscriber with this priority is allowed.

CapturePriorityNormal Normal priority. An application uses this priority to acquire events

from the fingerprint reader only if the operation runs in a foreground
process. Multiple subscribers with this priority are allowed.

CapturePriorityHigh High priority. A subscriber uses this priority to acquire events from the
fingerprint reader exclusively. Only one subscriber with this priority is
allowed.

Remarks
The members of this enumerated type are called by the IDPFPCapture::Priority property
(page 73).

Enumerated Type Information

Type library DigitalPersona One Touch for Windows Device components 1.0

Library DPFPDevX.dll

DPFPEventHandlerStatusEnum Enumerated Type

The DPFPEventHandlerStatusEnum enumerated type defines the codes that are returned by the
DPFPEventHandlerStatus object to indicate the status of an operation.

Syntax
typedef enum DPFPEventHandlerStatusEnum{
EventHandlerStatusSuccess = 0,
EventHandlerStatusFailure = 1,
} DPFPEventHandlerStatusEnum;

Constants

EventHandlerStatusSuccess An operation was performed successfully.

EventHandlerStatusFailure An operation failed.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 111
Chapter 6: API Reference for C++ Developers DPFPDataPurposeEnum Enumerated Type

Remarks
The members of this enumerated type are called by the IDPFPEventHandlerStatus::Status
property (page 87).

Enumerated Type Information

Type library DigitalPersona One Touch for Windows Control 1.0

Library DPFPShrX.dll

DPFPDataPurposeEnum Enumerated Type

The DPFPDataPurposeEnum enumerated type defines the purpose for which a fingerprint feature set is to
be used.

Syntax
typedef enum DPFPDataPurposeEnum{
DataPurposeUnknown = 0,
DataPurposeVerification = 1,
DataPurposeEnrollment = 2,
} DPFPDataPurposeEnum;

Constants

DataPurposeUnknown The purpose is not known.

DataPurposeVerification A fingerprint feature set to be used for the purpose of verification.

DataPurposeEnrollment A fingerprint feature set to be used for the purpose of enrollment.

Remarks
The members of this enumerated type are called by the
IDPFPFeatureExtraction::CreateFeatureSet method (page 88).

Enumerated Type Information

Type library DigitalPersona One Touch for Windows Engine components 1.0

Library DPFPEngX.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 112
Chapter 6: API Reference for C++ Developers DPFPReaderImpressionTypeEnum Enumerated Type

DPFPReaderImpressionTypeEnum Enumerated Type

The DPFPReaderImpressionTypeEnum enumerated type defines the modality that a fingerprint reader
uses to capture fingerprint samples.

Syntax
typedef enum DPFPReaderImpressionTypeEnum{
ReaderImpressionTypeUnknown = 0,
ReaderImpressionTypeSwipe = 1,
ReaderImpressionTypeArea = 2,
} DPFPReaderImpressionTypeEnum;

Constants

ReaderImpressionTypeUnknown A fingerprint reader for which the modality is not known.

ReaderImpressionTypeSwipe A swipe fingerprint reader.

ReaderImpressionTypeArea An area (touch) sensor fingerprint reader.

Remarks
The members of this enumerated type are called by the
IDPFPReaderDescription::ImpressionType property (page 93).

Enumerated Type Information

Type library DigitalPersona One Touch for Windows Device components 1.0

Library DPFPDevX.dll

DPFPReaderTechnologyEnum Enumerated Type

The DPFPReaderTechnologyEnum enumerated type defines the fingerprint reader technology.

Syntax
typedef enum DPFPReaderTechnologyEnum{
ReaderTechnologyUnknown = 0,
ReaderTechnologyOptical = 1,
ReaderTechnologyCapacitive = 2,
ReaderTechnologyThermal = 3,
ReaderTechnologyPressure = 4,
} DPFPReaderTechnologyEnum;

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 113
Chapter 6: API Reference for C++ Developers DPFPSerialNumberTypeEnum Enumerated Type

Constants

ReaderTechnologyUnknown A fingerprint reader for which the technology is not known.

ReaderTechnologyOptical An optical fingerprint reader.

ReaderTechnologyCapacitive A capacitive fingerprint reader.

ReaderTechnologyThermal A thermal fingerprint reader.

ReaderTechnologyPressure A pressure fingerprint reader.

Remarks
The members of this enumerated type are called by the IDPFPReaderDescription::Technology
property (page 94).

Enumerated Type Information

Type library DigitalPersona One Touch for Windows Device components 1.0

Library DPFPDevX.dll

DPFPSerialNumberTypeEnum Enumerated Type

The DPFPSerialNumberTypeEnum enumerated type defines whether a fingerprint reader serial number
persists after reboot.

Syntax
typedef enum DPFPSerialNumberTypeEnum{
SerialNumberTypePersistent = 0,
SerialNumberTypeVolatile = 1,
} DPFPSerialNumberTypeEnum;

Constants

SerialNumberTypePersistent A persistent serial number provided by the hardware.

SerialNumberTypeVolatile A volatile serial number provided by the software.

Remarks
The members of this enumerated type are called by the
IDPFPReaderDescription::SerialNumberType property (page 94).

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 114
Chapter 6: API Reference for C++ Developers DPFPTemplateStatusEnum Enumerated Type

Enumerated Type Information

Type library DigitalPersona One Touch for Windows Device components 1.0

Library DPFPDevX.dll

DPFPTemplateStatusEnum Enumerated Type

The DPFPTemplateStatusEnum enumerated type defines the status of a fingerprint template creation
operation.

Syntax
typedef enum DPFPTemplateStatusEnum{
TemplateStatusUnknown = 0,
TemplateStatusInsufficient = 1,
TemplateStatusFailed = 2,
TemplateStatusReady = 3,
} DPFPTemplateStatusEnum;

Constants

TemplateStatusUnknown The status of a template creation operation is not know,

probably because a fingerprint template does not exist yet.
TemplateStatusInsufficient A fingerprint template exists, but more fingerprint feature sets
are required to complete it.

TemplateStatusFailed A fingerprint template creation operation failed.

TemplateStatusReady A fingerprint template was created and is ready for use.

Remarks
The members of this enumerated type are called by the IDPFPEnrollment::TemplateStatus
property (page 81).

Enumerated Type Information

Type library DigitalPersona One Touch for Windows Engine components 1.0

Library DPFPEngX.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 115
User Interface 7

This chapter describes the functionality of the user interfaces included in the following component objects:
„ DPFPEnrollmentControl
This object includes the user interface described in the next section. The methods and properties for this
object are described on page 43 for Visual Basic and on page 80 and page 85 for C++.
„ DPFPVerificationControl
This object includes the user interface described on page 125. The methods and properties for this object
are described on page 60 for Visual Basic and page 104 and page 106 for C++.

DPFPEnrollmentControl Object User Interface

The user interface included with the DPFPEnrollmentControl object consists of two elements. The first
element is used to provide instructions for selecting a fingerprint to enroll or to unenroll (delete) and is used to
indicate already-enrolled fingerprints. The second element is used to provide instructions and feedback, both
graphically and textually, about the enrollment process.

The tables and figure in this section describe the interaction between the user and the user interface during
fingerprint enrollment and unenrollment (deletion).

NOTE: In the tables, the elements are referred to as the hands element and the numbers element.

Enrolling a Fingerprint
Figure 9 illustrates the fingerprint enrollment process using the DPFPEnrollmentControl object
interface. Picture numbers in the figure correspond to the pictures in Table 8 on page 118. Table 8 illustrates and
describes the interaction between the user and the user interface during fingerprint enrollment.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 116
Chapter 7: User Interface Enrolling a Fingerprint

6WDUW

3LFWXUH

8VHUFOLFNVILQJHU
8VHUFOLFNVXQHQUROOHGILQJHU

3LFWXUH
<HV
0D[LPXPWHPSODWHVFUHDWHG 0D[LPXP"

1R

1R
IHDWXUHVHWFUHDWHG

3LFWXUH 3LFWXUH
)LUVWILQJHUSULQW

8VHUFOLFNVKHUH &DQFHO <HV

:DLWLQJIRUXVHU *RWRVWDUW
HQUROOPHQW"

3LFWXUH$RU%
1R )HDWXUH
%DOORRQPHVVDJH
6HW2."
<HV
1R
3LFWXUH
6HFRQGILQJHUSULQW

3LFWXUH
IHDWXUHVHWFUHDWHG

8VHUFOLFNVKHUH &DQFHO <HV

:DLWLQJIRUXVHU *RWRVWDUW
HQUROOPHQW"

%DOORRQPHVVDJHDV 1R )HDWXUH
LQ3LFWXUH$RU% 6HW2."
<HV
1R
3LFWXUH 3LFWXUH
IHDWXUHVHWFUHDWHG
7KLUGILQJHUSULQW

8VHUFOLFNVKHUH &DQFHO <HV

:DLWLQJIRUXVHU *RWRVWDUW
HQUROOPHQW"

%DOORRQPHVVDJHDV 1R )HDWXUH
LQ3LFWXUH$RU% 6HW2."
<HV
1R
3LFWXUH 3LFWXUH
IHDWXUHVHWFUHDWHG
)RXUWKILQJHUSULQW

8VHUFOLFNVKHUH &DQFHO <HV

:DLWLQJIRUXVHU *RWRVWDUW
HQUROOPHQW"

%DOORRQPHVVDJHDV 1R )HDWXUH
LQ3LFWXUH$RU% 6HW2."
<HV
1R
)LQJHUSULQWWHPSODWHFUHDWHGDQGILQJHUSULQWHQUROOHG

3LFWXUH 3LFWXUH
8VHUFOLFNVKHUH &DQFHO <HV
:DLWLQJIRUXVHU *RWRVWDUW
HQUROOPHQW"

<HV
3LFWXUH
1R
%DOORRQPHVVDJH 7HPSODWH
2."
<HV

3LFWXUH

7HPSODWHFUHDWHG

3LFWXUH

%DOORRQPHVVDJH

(QG

Figure 9. Enrolling a fingerprint using the DPFPControlEnrollment object user interface

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 117
Chapter 7: User Interface Enrolling a Fingerprint

Table 8. DPFPEnrollmentControl object user interface: Enrolling a fingerprint

User interface User actions and user interface feedback

Picture 1 This image indicates that no fingerprints have been

enrolled, because the fingers associated with any enrolled
fingerprints are green.

Picture 2 The user clicked the right index finger, and control was
passed from the hands element to the numbers element.
The numbers element is ready to enroll the user’s right
index fingerprint, as indicated by the green finger on the
hand in the bottom left corner.

Picture 3 The user touched the fingerprint reader, and a fingerprint

feature set was created.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 118
Chapter 7: User Interface Enrolling a Fingerprint

Table 8. DPFPEnrollmentControl object user interface: Enrolling a fingerprint (continued)

User interface User actions and user interface feedback

Picture 4A The user touched the fingerprint reader, but a fingerprint

feature set was not created. The message that is displayed
depends on the quality of the fingerprint sample, as
shown in Pictures 4A and 4B.

Picture 4B

Picture 5 The user touched the fingerprint reader, and a second

fingerprint feature set was created.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 119
Chapter 7: User Interface Enrolling a Fingerprint

Table 8. DPFPEnrollmentControl object user interface: Enrolling a fingerprint (continued)

User interface User actions and user interface feedback

Picture 6 The user touched the fingerprint reader, and a third

fingerprint feature set was created.

Picture 7 The user touched the fingerprint reader, and a fourth

fingerprint feature set was created.

Picture 8 When a fingerprint template is created for the selected

finger, control is passed to the hands element.
This image appears when the OnEnroll event of the
DPFPEnrollmentControl object is fired and returns
a status of EventHandlerStatusSuccess.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 120
Chapter 7: User Interface Enrolling a Fingerprint

Table 8. DPFPEnrollmentControl object user interface: Enrolling a fingerprint (continued)

User interface User actions and user interface feedback

Picture 9 The hands element indicates that the right index

fingerprint is enrolled, that is, the finger is green.
The value of the EnrolledFingersMask property is
000000000 001000000, or 64.

Picture 10 A fingerprint template was not created for the selected

finger.
The user is instructed to try again, and control remains
with the numbers element.

Picture 11 This message appears when the user clicks here in Click
here to cancel enrollment. When the user clicks No, this
message is dismissed and control is returned to the
numbers element. When the user clicks Yes, this message
is dismissed and control is passed to the hands element.
The user can cancel enrollment at any time by clicking
here and then clicking Yes.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 121
Chapter 7: User Interface Enrolling a Fingerprint

Table 8. DPFPEnrollmentControl object user interface: Enrolling a fingerprint (continued)

User interface User actions and user interface feedback

Picture 12 This message is displayed when a user who has already

enrolled the maximum allowed number of fingerprints
(set by the MaxEnrollFingerCount property) clicks
a finger associated with an unenrolled finger in the hands
element. When the user clicks OK, control is returned to
the hands element.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 122
Chapter 7: User Interface Deleting a Fingerprint Template

Deleting a Fingerprint Template

Table 9 on page 123 illustrates and describes the interaction between the user and the user interface during
fingerprint template deletion.

Table 9. DPFPEnrollmentControl object user interface: Deleting a fingerprint template

User interface User actions and user interface feedback

The hands element indicates that the right index

fingerprint is enrolled, that is, the finger is green.
The value of the EnrolledFingersMask property is
000000000 001000000, or 64.

This message appears when the user clicks the right index
fingerprint (which was previously enrolled).
When the user clicks No, this message is dismissed and
control is returned to the hands element, which remains
unchanged.
When the user clicks Yes, this message is dismissed and
control is returned to the hands element, where the
Fingerprint Deleted message is displayed (see the next
picture).

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 123
Chapter 7: User Interface Deleting a Fingerprint Template

Table 9. DPFPEnrollmentControl object user interface: Deleting a fingerprint template (continued)

User interface User actions and user interface feedback

This image appears when the OnDelete event of the

DPFPEnrollmentControl object is fired and returns
a status of EventHandlerStatusSuccess.
The value of the EnrolledFingersMask property is
now set to 000000000 000000000, or 0.

The green color is removed from the right index finger,

indicating that the associated fingerprint is no longer
enrolled.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 124
Chapter 7: User Interface DPFPVerificationControl Object User Interface

DPFPVerificationControl Object User Interface

The user interface included with the DPFPVerificationControl object consists of one element. This
element is used to indicate the connection status of the fingerprint reader and to provide feedback about the
fingerprint verification process. Table 10 illustrates and describes the interaction between the user and the user
interface.

Table 10.DPFPVerificationControl object user interface

Graphical user interface User actions and user interface feedback

Indicates that the fingerprint reader is connected and ready for the user to scan
a finger.

Indicates that the fingerprint reader is disconnected.

Indicates a comparison decision of match from a fingerprint verification

operation.
This image appears when the OnComplete event of the
DPFPVerificationControl object is fired and returns a status of
EventHandlerStatusSuccess, and the value of the Verified
property of the DPFPVerificationResult object is true.

Indicates a comparison decision of non-match from a fingerprint verification

operation.
This image appears when the OnComplete event of the
DPFPVerificationControl object is fired and returns a status of
EventHandlerStatusSuccess, and the value of the Verified
property of the DPFPVerificationResult object is false.

Indicates that the fingerprint sample capture operation failed.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 125
Developing Citrix-aware applications 8

This SDK includes support for fingerprint authentication through Windows Terminal Services (including
Remote Desktop Connection) and through a Citrix connection to Metaframe Presentation Server using a client
from the Citrix Presentation Server Client package.

The following types of Citrix clients are supported for fingerprint authentication:

„ Program Neighborhood
„ Program Neighborhood Agent
„ Web Client
In order to utilize this support, your application (or the end-user) will need to copy a file to the client computer
and register it. The name of the file is DPICACnt.dl, and it is located in the "Misc\Citrix Support" folder in the
product package.

To deploy the DP library for Citrix support:

1. - Locate the DPICACnt.dll file on the DP Product CD in the "Misc\Citrix Support" folder.
2. Copy the file to the folder on the client computer where the Citrix client components are located (i.e. for
the Program Neighborhood client it might be the "Program Files\Citrix\ICA Client" folder).
3. Using the regsvr32.exe program, register the DPICACnt.dll library.
If you have several Citrix clients installed on a computer, deploy the DPICACnt.dll library to the Citrix client
folder for each client.

If your application will also be working with Pro Workstation 4.2.0 and later or Pro Kiosk 4.2.0 and later, you will
need to inform the end-user’s administrator that they will need to enable two Group Policy Objects (GPOs),
"Use DigitalPersona Pro Server for authentication" and "Allow Fingerprint Data Redirection". For information on
how to enable these policies, see the "DigitalPersona Pro for AD Guide.pdf" located on the DigitalPersona Pro
Server installation CD.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 126
Redistribution 9

You may redistribute the files in the RTE\Install and the Redist folders in the One Touch for Windows SDK
software package to your end users pursuant to the terms of the end user license agreement (EULA), attendant
to the software and located in the Docs folder in the SDK software package.

When you develop a product based on the One Touch for Windows SDK, you need to provide the
redistributables to your end users. These files are designed and licensed for use with your application. You may
include the installation files located in the RTE\Install folder in your application, or you may incorporate the
redistributables directly into your installer. You may also use the merge modules located in the Redist folder in
the SDK software package to create your own MSI installer.

Per the terms of the EULA, DigitalPersona grants you a non-transferable, non-exclusive, worldwide license to
redistribute, either directly or via the respective merge modules, the following files contained in the RTE\Install
and Redist folders in the One Touch for Windows SDK software package to your end users and to incorporate
these files into derivative works for sale and distribution:

RTE\Install Folder
„ InstallOnly.bat
„ Setup.exe
„ Setup.msi
„ UninstallOnly.bat

Redist Folder
„ DpCore.msm
This merge module contains the following files:
„ Dpcoper2.dll
„ Dpdevice2.dll
„ Dpfpapi.dll
„ Dphostw.exe
„ Dpmux.dll
„ Dpmsg.dll
„ Dpclback.dll
„ DPCrStor.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 127
Chapter 9: Redistribution Redist Folder

„ DpCore_x64.msm
This merge module contains the following files:
„ Dpcoper2.dll
„ Dpdevice2.dll
„ Dpfpapi.dll
„ Dphostw.exe
„ Dpmux.dll
„ Dpclback.dll
„ DPCrStor.dll
„ x64\Dpmsg.dll

„ DpDrivers.msm
This merge module contains the following files:
„ Dpd00701x64.dll
„ Dpdevctlx64.dll
„ Dpdevdatx64.dll
„ Dpersona_x64.cat
„ Dpersona_x64.inf
„ Dpi00701x64.dll
„ Dpinst32.exe
„ Dpinst64.exe
„ Usbdpfp.sys
„ Dpersona.cat
„ Dpersona.inf
„ Dpdevctl.dll
„ Dpdevdat.dll
„ Dpk00701.sys
„ Dpk00303.sys
„ Dpd00303.dll
„ Dpd00701.dll
„ Dpi00701.dll

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 128
Chapter 9: Redistribution Redist Folder

„ DpFpRec.msm
This merge module contains the following files:
„ Dphftrex.dll
„ Dphmatch.dll

„ DpFpRec_x64.msm
This merge module contains the following files:
„ <system folder>\Dphftrex.dll
„ <system folder>\Dphmatch.dll
„ <system64 folder>\Dphftrex.dll
„ <system64 folder>\Dphmatch.dll

„ DPFpUI.msm
This merge module contains the following file:
„ Dpfpui.dll

„ DPFpUI_x64.msm
This merge module contains the following file:
„ <system folder>\Dpfpui.dll
„ <system64 folder>\Dpfpui.dll

„ DpProCore.msm
This merge module contains the following files:
„ Dpdevts.dll
„ Dpsvinfo2.dll
„ Dptsclnt.dll

„ DpOTCOMActX.msm
This merge module contains the following files:
„ DPFPShrX.dll
„ DPFPDevX.dll
„ DPFPEngX.dll
„ DPFPCtlX.dll
„ DpOTCOMActX_x64.msm
This merge module contains the following files:

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 129
Chapter 9: Redistribution Fingerprint Reader Documentation

„ DPFPShrX.dll
„ DPFPDevX.dll
„ DPFPEngX.dll
„ DPFPCtlX.dll
„ x64\DpFpCtlX.dll
„ x64\DpFpDevX.dll
„ x64\DpFpEngX.dll
„ x64\DpFpShrX.dll
„ DpOTDotNET.msm
This merge module contains the following files:
„ DPFPShrNET.dll
„ DPFPDevNET.dll
„ DPFPEngNET.dll
„ DPFPVerNET.dll
„ DPFPGuiNET.dll
„ DPFPCtlXLib.dll
„ DPFPCtlXTypeLibNET.dll
„ DPFPCtlXWrapperNET.dll
„ DPFPShrXTypeLibNET.dll

Fingerprint Reader Documentation

You may redistribute the documentation included in the Redist folder in the One Touch for Windows SDK
software package to your end users pursuant to the terms of this section and of the EULA, attendant to the
software and located in the Docs folder in the SDK software package.

Hardware Warnings and Regulatory Information

If you distribute DigitalPersona U.are.U fingerprint readers to your end users, you are responsible for advising
them of the warnings and regulatory information included in the Warnings and Regulatory Information.pdf file
in the Redist folder in the One Touch for Windows SDK software package. You may copy and redistribute the
language, including the copyright and trademark notices, set forth in the Warnings and Regulatory
Information.pdf file.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 130
Chapter 9: Redistribution Fingerprint Reader Use and Maintenance Guide

Fingerprint Reader Use and Maintenance Guide

The DigitalPersona U.are.U fingerprint reader use and maintenance guides, DigitalPersona Reader
Maintenance Touch.pdf and DigitalPersona Reader Maintenance Swipe.pdf, are located in the Redist folder in
the One Touch for Windows SDK software package. You may copy and redistribute the DigitalPersona Reader
Maintenance Touch.pdf and the DigitalPersona Reader Maintenance Swipe.pdf files, including the copyright
and trademark notices, to those who purchase a U.are.U module or fingerprint reader from you.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 131
Setting the False Accept Rate A

This appendix is for developers who want to specify a false accept rate (FAR) other than the default used by the
DigitalPersona Fingerprint Recognition Engine.

False Accept Rate (FAR)

The false accept rate (FAR), also known as the security level, is the proportion of fingerprint verification
operations by authorized users that incorrectly returns a comparison decision of match. The FAR is typically
stated as the ratio of the expected number of false accept errors divided by the total number of verification
attempts, or the probability that a biometric system will falsely accept an unauthorized user. For example, a
probability of 0.001 (or 0.1%) means that out of 1,000 verification operations by authorized users, a system is
expected to return 1 incorrect match decision. Increasing the probability to, say, 0.0001 (or 0.01%) changes this
ratio from 1 in 1,000 to 1 in 10,000.

Increasing or decreasing the FAR has the opposite effect on the false reject rate (FRR), that is, decreasing the
rate of false accepts increases the rate of false rejects and vice versa. Therefore, a high security level may be
appropriate for an access system to a secured area, but may not be acceptable for a system where convenience
or easy access is more significant than security.

Representation of Probability
The DigitalPersona Fingerprint Recognition Engine supports the representation for the FAR probability that
fully conforms to the BIOAPI 1.1, BioAPI 2.0, and UPOS standard specifications. In this representation, the
probability is represented as a positive 32-bit integer, or zero. (Negative values are reserved for special uses.)

The definition PROBABILITY_ONE provides a convenient way of using this representation. PROBABILITY_ONE
has the value 0x7FFFFFFF (where the prefix 0x denotes base 16 notation), which is 2147483647 in decimal
notation. If the probability (P) is encoded by the value (INT_N), then

INT_N = P * PROBABILITY_ONE

INT_N
P=
PROBABILITY_ONE

Probability P should always be in the range from 0 to 1. Some common representations of probability are listed
in column one of Table 2. The value in the third row represents the current default value used by the
DigitalPersona Fingerprint Recognition Engine, which offers a mid-range security level. The value in the second
row represents a typical high FAR/low security level, and the value in the fourth row represents a typical low
FAR/high security level.
The resultant value of INT_N is represented in column two, in decimal notation.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 132
Appendix A: Setting the False Accept Rate

Table 2. Common values of probability and resultant INT_N values

Probability (P) Value of INT_N in decimal notation

0.001 = 0.1% = 1/1000 2147483

0.0001 = 0.01% = 1/10000 214748

0.00001 = 0.001% = 1/100000 21475

0.000001 = 0.0001% = 1/1000000 2147

Requested FAR
You specify the value of the FAR, which is INT_N from the previous equation, using the FARRequested
property (VB page 59, C++ page 102). While you can request any value from 0 to the value PROBABILITY_ONE, it
is not guaranteed that the Engine will fulfill the request exactly. The Engine implementation makes the best
effort to accommodate the request by internally setting the value closest to that requested within the
restrictions it imposes for security.

Specifying the FAR in Visual Basic

If you are developing your application in Visual Basic, you specify the value of the FAR (INT_N) in the lValue
parameter in the FARRequested property of the DPFPVerification object. The following sample
code sets the FAR to a value of 0.0001, or 0.01%.

Const PROBABILITY_ONE as Long = &H7FFFFFFF

Dim verification as new DPFPVerification()

...

' Sets the FAR to 0.01%

verification.FARRequested = PROBABILITY_ONE / 10000

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 133
Appendix A: Setting the False Accept Rate

Specifying the FAR in C++

If you are developing your application in C++, you specify the value of the FAR (INT_N) in the pVal parameter
of the IDPFPVerification::FARRequested property. The following sample code sets the FAR to a
value of 0.000001, or 0.0001%.

#define PROBABILITY_ONE (0x7FFFFFFF)

IDPFPVerification* verification;
...

//Sets the FAR to 0.0001%

rc = verification -> put_FARRequested (PROBABILITY_ONE / 1000000);

Achieved FAR
The actual value of the FAR achieved for a particular verification operation is returned in lValue parameter
of the FARAchieved property of the DPFPVerificationResult object in Visual Basic (page 62) or in
the pVal parameter of IDPFPVerificationResult::FARAchieved property in C++ (page 106).
This value is typically much smaller than the requested FAR due to the accuracy of the DigitalPersona
Fingerprint Recognition Engine. The requested FAR specifies the maximum value of the FAR to be used by the
Engine in making the verification decision. The actual FAR achieved by the Engine when conducting a
legitimate comparison is usually a much lower value. The Engine implementation may choose the range and
granularity for the achieved FAR. If you make use of this value in your application, for example, by combining it
with other achieved FARs, you should use it with caution, as the granularity and range may change between
versions of DigitalPersona SDKs without notice.

Testing
Although you may achieve the desired values of the FAR in your development environment, it is not
guaranteed that your application will achieve the required security level in real-world situations. Even though
the Engine is designed to make its best effort to accurately implement the probability estimates, it is
recommended that you conduct system-level testing to determine the actual operating point and accuracy in a
given scenario. This is even more important in systems where multiple biometric factors are used for
identification.

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 134
Platinum SDK Registration Template Conversion B

This appendix is for Platinum SDK users who need to convert their Platinum SDK registration templates to a
format that is compatible with the SDKs that are listed in Fingerprint Template Compatibility on page 5. You can
use the following sample codes for this purpose.

Platinum SDK Registration Template Conversion for Microsoft

Visual C++ Applications
Use Code Sample 1 in applications developed in Microsoft Visual C++ to convert DigitalPersona Platinum SDK
registration templates.

Code Sample 1. Platinum SDK Template Conversion for Microsoft Visual C++ Applications
#import "DpSdkEng.tlb" no_namespace, named_guids, raw_interfaces_only
#include <atlbase.h>

bool PlatinumTOGold(unsigned char* platinumBlob, int platinumBlobSize,

unsigned char* goldBlob, int goldBufferSize,
int* goldTemplateSize)
{
// Load the byte array into FPTemplate Object
// to create Platinum template object
SAFEARRAYBOUND rgsabound;
rgsabound.lLbound = 0;
rgsabound.cElements = platinumBlobSize;

CComVariant varVal;
varVal.vt = VT_ARRAY | VT_UI1;
varVal.parray = SafeArrayCreate(VT_UI1, 1, &rgsabound);

unsigned char* data;

if (FAILED(SafeArrayAccessData(varVal.parray, (void**)&data)))
return false;

memcpy(data, platinumBlob, platinumBlobSize);

SafeArrayUnaccessData(varVal.parray);

IFPTemplatePtr pIFPTemplate(__uuidof(FPTemplate));

if (pIFPTemplate == NULL)
return false;

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 135
Appendix B: Platinum SDK Registration Template Conversion

Code Sample 1. Platinum SDK Template Conversion for Microsoft Visual C++ Applications (continued)
AIErrors error;
if (FAILED(pIFPTemplate->Import(varVal, &error)))
return false;

if (error != Er_OK)
return false;

// Now pIFPTemplate contains the Platinum template.

// Use TemplData property to get the Gold Template out.
CComVariant varValGold;

if (FAILED(pIFPTemplate->get_TemplData(&varValGold)))
return false;

unsigned char* dataGold;

if (FAILED(SafeArrayAccessData(varValGold.parray, (void**)&dataGold)))
return false;

int blobSizeRequired = varValGold.parray->rgsabound->cElements *

varValGold.parray->cbElements;
*goldTemplateSize = blobSizeRequired;

if (goldBufferSize < blobSizeRequired) {

SafeArrayUnaccessData(varValGold.parray);
return false;
}

memcpy(goldBlob, dataGold, blobSizeRequired);

SafeArrayUnaccessData(varValGold.parray);

return true;

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 136
Appendix B: Platinum SDK Registration Template Conversion

Platinum SDK Registration Template Conversion for Visual

Basic 6.0 Applications
Use Code Sample 2 in applications developed in Microsoft Visual Basic 6.0 to convert DigitalPersona Platinum
SDK registration templates.

Code Sample 2. Platinum SDK Template Conversion for Visual Basic 6.0 Applications
Public Function PlatinumToGold(platinumTemplate As Variant) As Byte()
Dim pTemplate As New FPTemplate
Dim vGold As Variant
Dim bGold() As Byte

Dim er As DpSdkEngLib.AIErrors
er = pTemplate.Import(platinumTemplate)
If er <> Er_OK Then PlatinumToGold = "": Exit Function
vGold = pTemplate.TemplData
bGold = vGold
PlatinumToGold = bGold
End Function

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 137
Glossary

biometric system against their own fingerprint template(s) where an

An automatic method of identifying a person incorrect decision of non-match is returned.
based on the person’s unique physical and/or
features
behavioral traits, such as a fingerprint or an iris
pattern, or a handwritten signature or a voice. See fingerprint features.

comparison fingerprint
The estimation, calculation, or measurement of An impression of the ridges on the skin of a finger.
similarity or dissimilarity between fingerprint
fingerprint capture device
feature set(s) and fingerprint template(s).
A device that collects a signal of a fingerprint data
comparison score subject’s fingerprint characteristics and converts it to a
The numerical value resulting from a comparison of fingerprint sample. A device can be any piece of
fingerprint feature set(s) with fingerprint hardware (and supporting software and firmware). In
template(s). Comparison scores can be of two some systems, converting a signal from fingerprint
types: similarity scores or dissimilarity scores. characteristics to a fingerprint sample may include
multiple components such as a camera, photographic
context paper, printer, digital scanner, or ink and paper.
A temporary object used for passing data between
fingerprint characteristic
the steps of multi-step programming operations.
Biological finger surface details that can be detected
DigitalPersona Fingerprint Recognition Engine and from which distinguishing and repeatable
A set of mathematical algorithms formalized to fingerprint feature set(s) can be extracted for the
determine whether a fingerprint feature set purpose of fingerprint verification or fingerprint
matches a fingerprint template according to a enrollment.
specified security level in terms of the false accept
fingerprint data
rate (FAR).
Either the fingerprint feature set, the fingerprint
enrollee template, or the fingerprint sample.
See fingerprint data subject.
fingerprint data storage subsystem
enrollment A storage medium where fingerprint templates are
See fingerprint enrollment. stored for reference. Each fingerprint template is
associated with a fingerprint enrollment subject.
false accept rate (FAR) Fingerprint templates can be stored within a
The proportion of fingerprint verification fingerprint capture device; on a portable medium such
transactions by fingerprint data subjects not as a smart card; locally, such as on a personal computer
enrolled in the system where an incorrect decision or a local server; or in a central database.
of match is returned.
fingerprint data subject
false reject rate (FRR) A person whose fingerprint sample(s), fingerprint
The proportion of fingerprint verification feature set(s), or fingerprint template(s) are present
transactions by fingerprint enrollment subjects within the fingerprint recognition system at any time.

DigitalPersona One Touch for Windows SDK: C/C++ Edition | Developer Guide 138
Glossary

Fingerprint data can be either from a person being fingerprint reader

recognized or from a fingerprint enrollment A device that collects data from a person’s fingerprint
subject. features and converts it to a fingerprint image.
fingerprint enrollment fingerprint recognition system
a. In a fingerprint recognition system, the initial A biometric system that uses the distinctive and
process of collecting fingerprint data from a person persistent characteristics from the ridges of a finger,
by extracting the fingerprint features from the also referred to as fingerprint features, to distinguish
person’s fingerprint image for the purpose of one finger (or person) from another.
enrollment and then storing the resulting data in a
template for later comparison. fingerprint sample
b. The system function that computes a fingerprint The analog or digital representation of fingerprint
template from a fingerprint feature set(s). characteristics prior to fingerprint feature extraction
that are obtained from a fingerprint capture device. A
fingerprint enrollment subject fingerprint sample may be raw (as captured), or
The fingerprint data subject whose fingerprint intermediate (after some processing).
template(s) are held in the fingerprint data storage
fingerprint template
subsystem.
The output of a completed fingerprint enrollment
fingerprint feature extraction process that is stored in a fingerprint data storage
The system function that is applied to a fingerprint subsystem. Fingerprint templates are stored for later
sample to compute repeatable and distinctive comparison with a fingerprint feature set(s).
information to be used for fingerprint verification
fingerprint verification
or fingerprint enrollment. The output of the
fingerprint feature extraction function is a a. In a fingerprint recognition system, the process of
fingerprint feature set. extracting the fingerprint features from a person’s
fingerprint image provided for the purpose of
fingerprint features verification, comparing the resulting data to the
The distinctive and persistent characteristics from template generated during enrollment, and deciding
the ridges on the skin of a finger. See also if the two match.
fingerprint characteristics. b. The system function that performs a one-to-one
comparison and makes a decision of match or non-
fingerprint feature set
match.
The output of a completed fingerprint feature
extraction process applied to a fingerprint sample. match
A fingerprint feature set(s) can be produced for the The decision that the fingerprint feature set(s) and
purpose of fingerprint verification or for the the fingerprint template(s) being compared are from
purpose of fingerprint enrollment. the same fingerprint data subject.
fingerprint image non-match
A digital representation of fingerprint features prior The decision that the fingerprint feature set(s) and
to extraction that are obtained from a fingerprint the fingerprint template(s) being compared are not
reader. See also fingerprint sample. from the same fingerprint data subject.

DigitalPersona One Touch for Windows SDK: C/C++ Edition | Developer Guide 139
Glossary

one-to-one comparison
The process in which recognition fingerprint
feature set(s) from one or more fingers of one
fingerprint data subject are compared with
fingerprint template(s) from one or more fingers of
one fingerprint data subject.

repository
See fingerprint data storage subsystem.

security level
The target false accept rate for a comparison
context. See also FAR.

verification
See fingerprint verification.

DigitalPersona One Touch for Windows SDK: C/C++ Edition | Developer Guide 140
Index

Symbols converting Platinum SDK registration templates

_IDPFPCaptureEvents interface, defined 76 for Microsoft Visual Basic 6.0 applications 137
_IDPFPEnrollmentControlEvents interface, defined 85 for Microsoft Visual C++ applications 135
_IDPFPVerificationControlEvents interface, defined 106 ConvertToANSI381 method, defined
_NewEnum property, defined C++ 100
C++ 97 Visual Basic 57
Visual Basic 55 ConvertToPicture method, defined
C++ 100
A Visual Basic 57
AddFeatures method Count property, defined
calling in typical fingerprint enrollment workflow 22 C++ 96
defined Visual Basic 54
C++ 80 Courier bold typeface, use of 3
Visual Basic 41 CreateFeatureSet method
additional resources 4 calling
online resources 4 in typical fingerprint enrollment workflow 22
related documentation 4 in typical fingerprint verification workflow 28
Allow Fingerprint Data Redirection 126 defined
API reference C++ 88
C++ 71–115 Visual Basic 48
Visual Basic 34–70
audience for this guide 2 D
deleting a fingerprint
B See unenrolling a fingerprint
biometric system Deserialize method
defined 138 calling in fingerprint data object deserialization
explained 17 workflow 33
bold typeface, uses of 3 defined
C DPFPData object for Visual Basic 40
chapters, overview of 2 DPFPFeatureSet object for Visual Basic 49
Citrix 1 DPFPSample object for Visual Basic 56
Citrix Web Client 1 DPFPTemplate object for Visual Basic 58
Citrix, developing for 126 IDPFPData interface for C++ 78
Clear method IDPFPFeatureSet interface for C++ 90
calling in typical fingerprint enrollment workflow 23 IDPFPSample interface for C++ 98
defined IDPFPTemplate interface for C++ 101
C++ 80 deserializing fingerprint data object workflow 33
Visual Basic 41 DigitalPersona Fingerprint Recognition Engine 17
comparison, defined 138 DigitalPersona products, supported 5
compatible fingerprint templates document conventions 3
See fingerprint template compatibility documentation, related 4
component objects (Visual Basic) 34–62 DPFPCapture object for Visual Basic 36
See also individual components objects by name DPFPCapture object, creating
context in typical fingerprint enrollment workflow 22
defined 138 in typical fingerprint verification workflow 28
conventions, document DPFPCaptureEvents event handler, implementing
See document conventions in typical fingerprint enrollment workflow 22

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 141
Index E

in typical fingerprint verification workflow 28 defined 54

DPFPCaptureFeedbackEnum, defined DPFPReaderTechnologyEnum, defined
C++ 109 C++ 113
Visual Basic 64 Visual Basic 68
DPFPCapturePriorityEnum, defined DPFPSample object for Visual Basic, defined 56
C++ 110 DPFPSampleConversion object for Visual Basic,
Visual Basic 65 defined 57
DPFPData object for Visual Basic, defined 40 DPFPSerialNumberTypeEnum, defined
DPFPDataPurposeEnum, defined C++ 114
C++ 112 Visual Basic 69
Visual Basic 67 DPFPTemplate object
DPFPEnrollment object for Visual Basic, defined 41 creating
DPFPEnrollment object, creating, in typical fingerprint from serialized data
enrollment workflow 22 in typical fingerprint verification with UI support
DPFPEnrollmentControl object for Visual Basic, workflow 31
defined 43 in typical fingerprint verification workflow 28
DPFPEnrollmentControl object, creating in typical fingerprint enrollment workflow 22
in typical fingerprint enrollment with UI support serializing
workflow 24 in typical fingerprint enrollment with UI support
in typical fingerprint template deletion with UI workflow 25
support workflow 26 in typical fingerprint enrollment workflow 22
DPFPEnrollmentControlEvents event handler, storing
implementing, in typical fingerprint enrollment in typical fingerprint enrollment with UI support
with UI support workflow 24 workflow 25
DPFPEnrollmentControlEvents event handler, in typical fingerprint enrollment workflow 22
implementing, in typical fingerprint template DPFPTemplate object for Visual Basic, defined 58
deletion with UI support workflow 26 DPFPTemplateStatusEnum, defined
DPFPEventHandlerStatus object for Visual Basic, C++ 115
defined 47 Visual Basic 70
DPFPEventHandlerStatusEnum, defined DPFPVerification object for Visual Basic, defined 59
C++ 111 DPFPVerification object, creating
Visual Basic 66 in typical fingerprint verification with UI support
DPFPFeatureExtraction object for Visual Basic, workflow 31
defined 48 in typical fingerprint verification workflow 28
DPFPFeatureExtraction object, creating DPFPVerificationControl object for Visual Basic,
in typical fingerprint enrollment workflow 22 defined 60
in typical fingerprint verification workflow 28 DPFPVerificationControl object, creating, in typical
DPFPFeatureSet object fingerprint verification with UI support workflow 31
creating DPFPVerificationControlEvents event handler,
in typical fingerprint enrollment workflow 22 implementing, in typical fingerprint verification
in typical fingerprint verification workflow 28 with UI support workflow 31
receiving, in typical fingerprint verification DPFPVerificationResult object for Visual Basic, defined 62
workflow 31 DPFPVerificationResult object, receiving
DPFPFeatureSet object for Visual Basic, defined 49 in typical fingerprint verification with UI support
DPFPReaderDescription object for Visual Basic, workflow 31
defined 50 in typical fingerprint verification workflow 29
DPFPReaderImpressionTypeEnum, defined
C++ 113
E
Visual Basic 68 Engine
DPFPReadersCollection object for Visual Basic, See DigitalPersona Fingerprint Recognition Engine

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 142
Index F

EnrolledFingersMask property in typical verification workflow 28

defined to other than the default 133
C++ 82 features
Visual Basic 43 See fingerprint features
setting FeatureSet property
in typical fingerprint enrollment with UI support defined
workflow 24 C++ 89
in typical fingerprint template deletion with UI Visual Basic 49
support workflow 26 FeaturesNeeded property, defined
enrollee 18 C++ 80
enrolling a fingerprint 24 Visual Basic 41
enrollment files and folders
See fingerprint enrollment installed for RTE
enrollment mask, possible values for 32-bit installation 14
C++ 83 64-bit installation 15
Visual Basic 44, 83 installed for SDK 13
enumerations finger index, possible values for 46, 86
C++ 108–115 fingerprint 17
See also individual enumerated types by name defined 138
Visual Basic 63–70 workflow for enrolling with UI support 24
See also individual enumerations by name workflow for unenrolling (deleting) with UI support 25
fingerprint capture device 18
F defined 138
false accept rate 19 See fingerprint reader
defined 138 fingerprint characteristics, defined 138
setting to value other than the default 132 fingerprint data 18
false negative decision 19 defined 138
false negative decision, proportion of 19 fingerprint data object 40, 78
See also false accept rate
retrieving serialized data from storage 33
false positive decision 19
serialization/deserialization workflow 32
false positive decision, proportion of 19
storing serialized data, in fingerprint data object
See also false accept rate
serialization workflow 32
false positives and false negatives 19
fingerprint data storage subsystem, defined 138
false reject rate 19
fingerprint deletion
defined 138
See fingerprint unenrollment
FAR
fingerprint enrollment 18
See false accept rate
defined 139
FARAchieved property
with UI support workflows 23
defined
workflow 20
C++ 106
fingerprint feature extraction
Visual Basic 62
defined 139
explanation of 134
fingerprint feature set 18
FARRequested property
defined 139
defined
See also DPFPFeatureSet object
C++ 102
fingerprint features, defined 139
Visual Basic 59
fingerprint image, defined 139
important notice to read Appendix A before
fingerprint reader 18
setting 59, 103
defined 139
setting redistributing documentation for 130
in typical verification with UI support workflow 31 use and maintenance guides, redistributing 131

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 143
Index G

fingerprint recognition 18 G
fingerprint recognition system 17 Group Policy Objects 126
defined 139
See also DigitalPersona fingerprint recognition system H
fingerprint recognition, guide to 4 hardware warnings and regulatory information,
fingerprint sample redistributing 130
capturing HardwareRevision property
in typical fingerprint enrollment with UI support defined
workflow 25 C++ 92
in typical fingerprint enrollment workflow 22 Visual Basic 51
in typical fingerprint verification with UI support I
workflow 31 IDPFPCapture interface for C++, defined 73
in typical fingerprint verification workflow 28 IDPFPData interface for C++, defined 78
See also DPFPSample object IDPFPEnrollment interface for C++, defined 80
fingerprint sample, defined 139 IDPFPEnrollmentControl interface for C++, defined 82
See fingerprint image IDPFPEventHandlerStatus interface for C++, defined 87
fingerprint template 18 IDPFPFeatureExtraction interface for C++, defined 88
creating, workflow for with UI support 24 IDPFPFeatureSet interface for C++, defined 90
defined 139 IDPFPReaderDescription interface for C++, defined 91
deleting from storage, in typical fingerprint template IDPFPReadersCollection interface for C++, defined 95
deletion workflow 26 IDPFPSample interface for C++, defined 98
retrieving serialized data from storage IDPFPSampleConversion interface for C++, defined 99
in typical fingerprint verification with UI support IDPFPTemplate interface for C++, defined 101
workflow 31 IDPFPVerification interface for C++, defined 102
in typical fingerprint verification workflow 28 IDPFPVerificationControl interface for C++, defined 104
serializing, in typical fingerprint enrollment IDPFPVerificationResult interface for C++, defined 106
workflow 22 image
storing See fingerprint image
in typical fingerprint enrollment with UI support important notation, defined 3
workflow 25 important notice
in typical fingerprint enrollment workflow 22 read Appendix A before setting FARRequested
workflow for enrolling 20 property 59, 103
See also DPFPTemplate object set optional properties to maintain consistent
fingerprint template compatibility 5 application functionality 34, 71
fingerprint unenrollment, workflow 25 ImpressionType property, defined
fingerprint verification 18 C++ 93
defined 139 Visual Basic 51
fingerprint verification with UI support workflow 29 installation 12
fingerprint verification workflow 26 installation files for redistributables, redistributing 127
FirmwareRevision property installing
defined RTE 13
C++ 91 RTE silently 16
Visual Basic 50 SDK 12
folders and files interfaces (C++) 71–107
installed for RTE See also individual interfaces by name
32-bit installation 14 introduction to developer guide 1
64-bit installation 15 italics typeface, uses of 3
installed for SDK 13 Item property, defined
FRR C++ 97
See false reject rate Visual Basic 55

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 144
Index L

L C++ 86
l1FingersMask, possible values for in Visual Basic 46 Visual Basic 47
Language property, defined receiving, in typical fingerprint template with UI
C++ 92 support workflow 25
Visual Basic 51 one-to-one comparison 19
defined 140
M OnFingerGone event, defined
match 19 C++ 76
defined 139 Visual Basic 38
MaxEnrollFingerCount property OnFingerTouch event, defined
defined C++ 77
C++ 84 Visual Basic 38
Visual Basic 44 online resources 4
setting OnReaderConnect event defined
in typical fingerprint enrollment with UI support C++ 77
workflow 25 Visual Basic 39
merge modules OnReaderDisconnect event, defined
contents of 127 C++ 77
redistributing 127 Visual Basic 39
Metaframe Presentation Server 1 OnSampleQuality event, defined
N C++ 78
naming conventions 3 Visual Basic 39
non-match 19 overview
defined 139 of chapters 2
notational conventions 3 of SDK 17
note notation, defined 3 P
O Platinum SDK registration template conversion 135
OnComplete event Priority property
DPFPCaptureEvents defined
defined C++ 73
C++ 76 Visual Basic 36
Visual Basic 38 setting
receiving in typical fingerprint enrollment workflow 22
in typical fingerprint enrollment workflow 22 in typical fingerprint verification workflow 28
in typical fingerprint verification workflow 28 product compatibility
DPFPVerificationControlEvents See fingerprint template compatibility
defined ProductName property, defined
C++ 106 C++ 93
Visual Basic 61 Visual Basic 52
receiving, in typical fingerprint verification with UI Program Neighborhood 1
support workflow 31 Program Neighborhood Agent 1
OnDelete event Q
defined quick start, introduction to SDK 6
C++ 86
Visual Basic 46 R
receiving, in typical fingerprint template with UI Reader method, defined
support workflow 26 C++ 96
OnEnroll event Visual Basic 54
defined ReaderSerialNumber property

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 145
Index S

defined calling in fingerprint data object serialization

DPFPCapture workflow 32
C++ 74 DPFPData object for Visual Basic 40
Visual Basic 37 DPFPFeatureSet object for Visual Basic 50
DPFPEnrollmentControl DPFPSample object for Visual Basic 56
C++ 84 DPFPTemplate object for Visual Basic 58
Visual Basic 45 IDPFPData interface for C++ 79
DPFPVerificationControl IDPFPFeatureSet interface for C++ 91
C++ 105 IDPFPSample interface for C++ 99
Visual Basic 60 IDPFPTemplate interface for C++ 102
setting serializing fingerprint data object workflow 32
in typical fingerprint enrollment with UI support SerialNumber property, defined
workflow 25 C++ 93
in typical fingerprint enrollment workflow 22 Visual Basic 52
in typical fingerprint verification with UI support SerialNumberType property, defined
workflow 31 C++ 94
in typical fingerprint verification workflow 28 Visual Basic 52
Redist folder, redistributing contents of 127 silently installing RTE 16
redistributables, redistributing 127 StartCapture method
redistribution of files 127 calling
regulatory information, requirement to advise end users in typical fingerprint enrollment workflow 22
of 130 in typical fingerprint verification workflow 28
remote authentication 1 defined
Remote Desktop Connection 1 C++ 74
repository 18 Visual Basic 36
requirements, system Status property, defined
See system requirements C++ 87
resources, additional Visual Basic 47
See additional resources StopCapture method
resources, online calling
See online resources in typical fingerprint enrollment workflow 22
RTE in typical fingerprint verification workflow 28
installing 13 defined
installing/uninstalling silently 16 C++ 75
redistributing 127 Visual Basic 36
RTE\Install folder, redistributing contents of 127 supported DigitalPersona products 5
runtime environment system requirements 4
See RTE
T
S target audience for this guide 2
sample code for converting Platinum SDK registration Technology property, defined
templates C++ 94
for Microsoft Visual Basic 6.0 applications 137 Visual Basic 53
for Microsoft Visual C++ applications 135 template compatibility
SDK See fingerprint template compatibility
files and folders installed 13 Template property, defined
installing 12 C++ 81
quick start 6 Visual Basic 42
security level 20 TemplateStatus property, defined
Serialize method C++ 81

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 146
Index U

Visual Basic 42
typefaces, uses of 3
typographical conventions 3
U
uFingerMask parameter, possible values for in C++ 86
unenrolling a fingerprint 25
uninstalling RTE silently 16
updates for DigitalPersona software products, URL for
downloading 4
URL
DigitalPersona Developer Connection Forum 4
Updates for DigitalPersona Software Products 4
use and maintenance guides for fingerprint readers,
redistributing 131
Use DigitalPersona Pro Server for authentication 126
V
Vendor property, defined
C++ 95
Visual Basic 53
verification
See fingerprint verification
Verified property, defined
C++ 107
Visual Basic 62
Verify method
calling
in typical fingerprint verification with UI support
workflow 31
in typical fingerprint verification workflow 28
defined
C++ 103
Visual Basic 59
W
Web site
DigitalPersona Developer Connection Forum 4
Updates for DigitalPersona Software Products 4
Windows Terminal Services 1
workflows 20–33

DigitalPersona One Touch for Windows SDK: COM/ActiveX Edition | Developer Guide 147