Document Title Here
AET65 API
Version 1.0
idvation GmbH
Otto-Hesse-Straße 19 / T5
Phone +49 6151 9926567
D-64293 Darmstadt
Fax +49 6151 3689296
www.idvation.com
Page 82 of 84
Page 82 of 84
8.0. New Features in Version 3.5
8.1. Global Parameter ABS_PARAM_IFACE_VERSION
New global parameter ABS_PARAM_IFACE_VERSION was added, which allows the caller to detect the
interface of the BSAPI because version 3.5 of BSAPI brings one incompatibility with previous version:
dynamic enrollment (see below).
The old interface (which does not support this parameter) is version 1. Current version is 2. Future versions
of BSAPI will use higher numbers if they will introduce new incompatibilities.
To distinguish between version 1 and 2 of the interface programmatically, call ABSGetGlobalParameter()
with
dwParam
set
to
ABS_PARAM_IFACE_VERSION.
If
the
return
value
is
ABS_STATUS_NOT_SUPPORTED, it's interface version 1. If ABS_STATUS_OK is returned, interpret the
returned output parameter to determine number of the interface.
Note that this parameter is designed to be read-only. I.e. you can only get its value with
ABSGetGlobalParameter().
Attempting
to
use
it
in
ABSSetGlboalParameter()
will
fail
with
ABS_STATUS_NOT_SUPPORTED.
8.2. Dynamic Enrollment
Since version 3.5 BSAPI.DLL uses a dynamic enrollment. This means that there is no a priori known count
how many swipes are required to enroll a finger. During the enrollment process the resulted fingerprint
template is actualized and analyzed after each finger scan, and the process finishes when BSAPI evaluates
quality of the fingerprint template as sufficient.
This change required several changes in the API.
8.2.1.
Global Parameter ABS_PARAM_CONSOLIDATION_COUNT
This global parameter was already present in older version of BSAPI however set of supported values have
changed. Old version supported 3 and 5 swipes mostly on all devices. Currently only values 0 (default,
meaning the dynamic enrollment) and 5 are supported.
Value 3 is not longer supported since version 3.5.
8.2.2.
Structure ABS_PROCESS_BEGIN_DATA
Message ABS_MSG_PROCESS_BEGIN has attached some information, pointed by last parameter sent to
ABS_CALLBACK function. The data are described by ABS_PROCESS_BEGIN_DATA.
Now the member StepCount can be set to zero if count of steps is not known, e.g. as in case of dynamic
enrollment.
8.2.3.
Structure ABS_PROCESS_PROGRESS_DATA
Message ABS_MSG_PROCESS_PROGRESS now comes with more data. Previously it was accompanied
with ABS_PROCESS_DATA, now ABS_PROCESS_PROGRESS_DATA is sent.
Note that ABS_PROCESS_PROGRESS_DATA is binary compatible with ABS_PROCESS_DATA.
ABS_PROCESS_PROGRESS_DATA is superset of ABS_PROCESS_DATA. Beside the old ProcessID
member, ABS_PROCESS_PROGRESS_DATA has member Percentage which informs the caller how the
operation progresses.
The process (e.g. the dynamic enrollment) ends when the Percentage reaches 100. For processes where
the Percentage is not applicable, it's set to 0xFFFFFFFF.
8.2.4.
Constant ABS_PROCESS_CONSOLIDATE
The enrollment process has been changed and the separate finger templates are consolidated into the
resulted enrollment template gradually so the consolidation is not single step of the enrollment process.
