WINBIO_ENGINE_INTERFACE structure

The WINBIO_ENGINE_INTERFACE structure contains pointers to your custom engine adapter functions. The Windows Biometric Framework uses this structure to locate the functions.

Syntax


typedef struct _WINBIO_ENGINE_INTERFACE {
  WINBIO_ADAPTER_INTERFACE_VERSION                 Version;
  WINBIO_ADAPTER_TYPE                              Type;
  SIZE_T                                           Size;
  GUID                                             AdapterId;
  PIBIO_ENGINE_ATTACH_FN                           Attach;
  PIBIO_ENGINE_DETACH_FN                           Detach;
  PIBIO_ENGINE_CLEAR_CONTEXT_FN                    ClearContext;
  PIBIO_ENGINE_QUERY_PREFERRED_FORMAT_FN           QueryPreferredFormat;
  PIBIO_ENGINE_QUERY_INDEX_VECTOR_SIZE_FN          QueryIndexVectorSize;
  PIBIO_ENGINE_QUERY_HASH_ALGORITHMS_FN            QueryHashAlgorithms;
  PIBIO_ENGINE_SET_HASH_ALGORITHM_FN               SetHashAlgorithm;
  PIBIO_ENGINE_QUERY_SAMPLE_HINT_FN                QuerySampleHint;
  PIBIO_ENGINE_ACCEPT_SAMPLE_DATA_FN               AcceptSampleData;
  PIBIO_ENGINE_EXPORT_ENGINE_DATA_FN               ExportEngineData;
  PIBIO_ENGINE_VERIFY_FEATURE_SET_FN               VerifyFeatureSet;
  PIBIO_ENGINE_IDENTIFY_FEATURE_SET_FN             IdentifyFeatureSet;
  PIBIO_ENGINE_CREATE_ENROLLMENT_FN                CreateEnrollment;
  PIBIO_ENGINE_UPDATE_ENROLLMENT_FN                UpdateEnrollment;
  PIBIO_ENGINE_GET_ENROLLMENT_STATUS_FN            GetEnrollmentStatus;
  PIBIO_ENGINE_GET_ENROLLMENT_HASH_FN              GetEnrollmentHash;
  PIBIO_ENGINE_CHECK_FOR_DUPLICATE_FN              CheckForDuplicate;
  PIBIO_ENGINE_COMMIT_ENROLLMENT_FN                CommitEnrollment;
  PIBIO_ENGINE_DISCARD_ENROLLMENT_FN               DiscardEnrollment;
  PIBIO_ENGINE_CONTROL_UNIT_FN                     ControlUnit;
  PIBIO_ENGINE_CONTROL_UNIT_PRIVILEGED_FN          ControlUnitPrivileged;
#ifdef WINBIO_ENGINE_INTERFACE_VERSION_2
  PIBIO_STORAGE_NOTIFY_POWER_CHANGE_FN             NotifyPowerChange;
  PIBIO_ENGINE_RESERVED_1_FN                       Reserved_1;
#ifdef WINBIO_ENGINE_INTERFACE_VERSION_3
  PIBIO_ENGINE_PIPELINE_INIT_FN                    PipelineInit;
  PIBIO_ENGINE_PIPELINE_CLEANUP_FN                 PipelineCleanup;
  PIBIO_ENGINE_ACTIVATE_FN                         Activate;
  PIBIO_ENGINE_DEACTIVATE_FN                       Deactivate;
  PIBIO_ENGINE_QUERY_EXTENDED_INFO_FN              QueryExtendedInfo;
  PIBIO_ENGINE_IDENTIFY_ALL_FN                     IdentifyAll;
  PIBIO_ENGINE_SET_ENROLLMENT_SELECTOR_FN          SetEnrollmentSelector;
  PIBIO_ENGINE_SET_ENROLLMENT_PARAMETERS_FN        SetEnrollmentParameters;
  PIBIO_ENGINE_QUERY_EXTENDED_ENROLLMENT_STATUS_FN QueryExtendedEnrollmentStatus;
  PIBIO_ENGINE_REFRESH_CACHE_FN                    RefreshCache;
  PIBIO_ENGINE_SELECT_CALIBRATION_FORMAT_FN        SelectCalibrationFormat;
  PIBIO_ENGINE_QUERY_CALIBRATION_DATA_FN           QueryCalibrationData;
  PIBIO_ENGINE_SET_ACCOUNT_POLICY_FN               SetAccountPolicy;
#ifdef WINBIO_ENGINE_INTERFACE_VERSION_4
  PIBIO_ENGINE_CREATE_KEY_FN                       CreateKey;
  PIBIO_ENGINE_IDENTIFY_FEATURE_SET_SECURE_FN      IdentifyFeatureSetSecure;
} WINBIO_ENGINE_INTERFACE, *PWINBIO_ENGINE_INTERFACE;

Members

Version

Version number of this structure.

Windows 10:  The version number must be WINBIO_ENGINE_INTERFACE_VERSION_3 or WINBIO_ENGINE_INTERFACE_VERSION_4. For more information on implementing WINBIO_ENGINE_INTERFACE_VERSION_4, see Sensor requirements for secure biometrics.

Windows Server 2012 R2, Windows 8.1, Windows Server 2012 and Windows 8:  The version number must be WINBIO_ENGINE_INTERFACE_VERSION_2.

Windows Server 2008 R2 and Windows 7:  The version number must be WINBIO_ENGINE_INTERFACE_VERSION_1.

Type

The type of adapter. This must be WINBIO_ADAPTER_TYPE_ENGINE.

Size

The size, in bytes, of this structure. Set this value to the size of the WINBIO_ENGINE_INTERFACE structure.

AdapterId

A GUID that uniquely identifies the engine adapter. You must generate this value.

Attach

A pointer to your implementation of the EngineAdapterAttach function.

Detach

A pointer to your implementation of the EngineAdapterDetach function.

ClearContext

A pointer to your implementation of the EngineAdapterClearContext function.

QueryPreferredFormat

A pointer to your implementation of the EngineAdapterQueryPreferredFormat function.

QueryIndexVectorSize

A pointer to your implementation of the EngineAdapterQueryIndexVectorSize function.

QueryHashAlgorithms

A pointer to your implementation of the EngineAdapterQueryHashAlgorithms function.

SetHashAlgorithm

A pointer to your implementation of the EngineAdapterSetHashAlgorithm function.

QuerySampleHint

A pointer to your implementation of the EngineAdapterQuerySampleHint function.

AcceptSampleData

A pointer to your implementation of the EngineAdapterAcceptSampleData function.

ExportEngineData

A pointer to your implementation of the EngineAdapterExportEngineData function.

VerifyFeatureSet

A pointer to your implementation of the EngineAdapterVerifyFeatureSet function.

IdentifyFeatureSet

A pointer to your implementation of the EngineAdapterIdentifyFeatureSet function.

CreateEnrollment

A pointer to your implementation of the EngineAdapterCreateEnrollment function.

UpdateEnrollment

A pointer to your implementation of the EngineAdapterUpdateEnrollment function.

GetEnrollmentStatus

A pointer to your implementation of the EngineAdapterGetEnrollmentStatus function.

GetEnrollmentHash

A pointer to your implementation of the EngineAdapterGetEnrollmentHash function.

CheckForDuplicate

A pointer to your implementation of the EngineAdapterCheckForDuplicate function.

CommitEnrollment

A pointer to your implementation of the EngineAdapterCommitEnrollment function.

DiscardEnrollment

A pointer to your implementation of the EngineAdapterDiscardEnrollment function.

ControlUnit

A pointer to your implementation of the EngineAdapterControlUnit function.

ControlUnitPrivileged

A pointer to your implementation of the EngineAdapterControlUnitPrivileged function.

NotifyPowerChange

A pointer to your implementation of the EngineAdapterNotifyPowerChange function. This member is supported starting in Windows 8.

Reserved_1

This field is reserved and should be set to NULL.

PipelineInit

A pointer to your implementation of the EngineAdapterPipelineInit function. This member is supported starting in Windows 10.

PipelineCleanup

A pointer to your implementation of the EngineAdapterPipelineCleanup function. This member is supported starting in Windows 10.

Activate

A pointer to your implementation of the EngineAdapterActivate function. This member is supported starting in Windows 10.

Deactivate

A pointer to your implementation of the EngineAdapterDeactivate function. This member is supported starting in Windows 10.

QueryExtendedInfo

A pointer to your implementation of the EngineAdapterQueryExtendedInfo function. This member is supported starting in Windows 10.

IdentifyAll

A pointer to your implementation of the EngineAdapterIdentifyAll function. This member is supported starting in Windows 10.

SetEnrollmentSelector

A pointer to your implementation of the EngineAdapterSetEnrollmentSelector function. This member is supported starting in Windows 10.

SetEnrollmentParameters

A pointer to your implementation of the EngineAdapterSetEnrollmentParameters function. This member is supported starting in Windows 10.

QueryExtendedEnrollmentStatus

A pointer to your implementation of the EngineAdapterQueryExtendedEnrollmentStatus function. This member is supported starting in Windows 10.

RefreshCache

A pointer to your implementation of the EngineAdapterRefreshCache function. This member is supported starting in Windows 10.

SelectCalibrationFormat

A pointer to your implementation of the EngineAdapterSelectCalibrationFormat function. This member is supported starting in Windows 10.

QueryCalibrationData

A pointer to your implementation of the EngineAdapterQueryCalibrationData function. This member is supported starting in Windows 10.

SetAccountPolicy

A pointer to your implementation of the EngineAdapterSetAccountPolicy function. This member is supported starting in Windows 10.

CreateKey

A pointer to your implementation of the EngineAdapterCreateKey function. This member is supported starting in Windows 10, version 1607.

IdentifyFeatureSetSecure

A pointer to your implementation of the EngineAdapterIdentifyFeatureSetSecure function. This member is supported starting in Windows 10, version 1607.

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Winbio_adapter.h

See also

Plug-in Functions
Plug-in Structures
WbioQueryEngineInterface

 

 

Show: