WINBIO_STORAGE_INTERFACE structure

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

Syntax


typedef struct _WINBIO_STORAGE_INTERFACE {
  WINBIO_ADAPTER_INTERFACE_VERSION         Version;
  WINBIO_ADAPTER_TYPE                      Type;
  SIZE_T                                   Size;
  GUID                                     AdapterId;
  PIBIO_STORAGE_ATTACH_FN                  Attach;
  PIBIO_STORAGE_DETACH_FN                  Detach;
  PIBIO_STORAGE_CLEAR_CONTEXT_FN           ClearContext;
  PIBIO_STORAGE_CREATE_DATABASE_FN         CreateDatabase;
  PIBIO_STORAGE_ERASE_DATABASE_FN          EraseDatabase;
  PIBIO_STORAGE_OPEN_DATABASE_FN           OpenDatabase;
  PIBIO_STORAGE_CLOSE_DATABASE_FN          CloseDatabase;
  PIBIO_STORAGE_GET_DATA_FORMAT_FN         GetDataFormat;
  PIBIO_STORAGE_GET_DATABASE_SIZE_FN       GetDatabaseSize;
  PIBIO_STORAGE_ADD_RECORD_FN              AddRecord;
  PIBIO_STORAGE_DELETE_RECORD_FN           DeleteRecord;
  PIBIO_STORAGE_QUERY_BY_SUBJECT_FN        QueryBySubject;
  PIBIO_STORAGE_QUERY_BY_CONTENT_FN        QueryByContent;
  PIBIO_STORAGE_GET_RECORD_COUNT_FN        GetRecordCount;
  PIBIO_STORAGE_FIRST_RECORD_FN            FirstRecord;
  PIBIO_STORAGE_NEXT_RECORD_FN             NextRecord;
  PIBIO_STORAGE_GET_CURRENT_RECORD_FN      GetCurrentRecord;
  PIBIO_STORAGE_CONTROL_UNIT_FN            ControlUnit;
  PIBIO_STORAGE_CONTROL_UNIT_PRIVILEGED_FN ControlUnitPrivileged;
#ifdef WINBIO_STORAGE_INTERFACE_VERSION_2
  PIBIO_STORAGE_NOTIFY_POWER_CHANGE_FN     NotifyPowerChange;
#endif 
#ifdef WINBIO_STORAGE_INTERFACE_VERSION_3
  PIBIO_STORAGE_PIPELINE_INIT_FN           PipelineInit;
  PIBIO_STORAGE_PIPELINE_CLEANUP_FN        PipelineCleanup;
  PIBIO_STORAGE_ACTIVATE_FN                Activate;
  PIBIO_STORAGE_DEACTIVATE_FN              Deactivate;
  PIBIO_STORAGE_QUERY_EXTENDED_INFO_FN     QueryExtendedInfo;
#endif 
} WINBIO_STORAGE_INTERFACE, *PWINBIO_STORAGE_INTERFACE;

Members

Version

Version number of this structure.

Windows 10:  The version number must be WINBIO_STORAGE_INTERFACE_VERSION_3.

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

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

Type

The type of adapter. This must be WINBIO_ADAPTER_TYPE_STORAGE.

Size

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

AdapterId

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

Attach

A pointer to your implementation of the StorageAdapterAttach function.

Detach

A pointer to your implementation of the StorageAdapterDetach function.

ClearContext

A pointer to your implementation of the StorageAdapterClearContext function.

CreateDatabase

A pointer to your implementation of the StorageAdapterCreateDatabase function.

EraseDatabase

A pointer to your implementation of the StorageAdapterEraseDatabase function.

OpenDatabase

A pointer to your implementation of the StorageAdapterOpenDatabase function.

CloseDatabase

A pointer to your implementation of the StorageAdapterCloseDatabase function.

GetDataFormat

A pointer to your implementation of the StorageAdapterGetDataFormat function.

GetDatabaseSize

A pointer to your implementation of the StorageAdapterGetDatabaseSize function.

AddRecord

A pointer to your implementation of the StorageAdapterAddRecord function.

DeleteRecord

A pointer to your implementation of the StorageAdapterDeleteRecord function.

QueryBySubject

A pointer to your implementation of the StorageAdapterQueryBySubject function.

QueryByContent

A pointer to your implementation of the StorageAdapterQueryByContent function.

GetRecordCount

A pointer to your implementation of the StorageAdapterGetRecordCount function.

FirstRecord

A pointer to your implementation of the StorageAdapterFirstRecord function.

NextRecord

A pointer to your implementation of the StorageAdapterNextRecord function.

GetCurrentRecord

A pointer to your implementation of the StorageAdapterGetCurrentRecord function.

ControlUnit

A pointer to your implementation of the StorageAdapterControlUnit function.

ControlUnitPrivileged

A pointer to your implementation of the StorageAdapterControlUnitPrivileged function.

NotifyPowerChange

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

PipelineInit

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

PipelineCleanup

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

Activate

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

Deactivate

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

QueryExtendedInfo

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

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
WbioQueryStorageInterface

 

 

Show: