PIBIO_STORAGE_ERASE_DATABASE_FN callback function (winbio_adapter.h)

Called by the Windows Biometric Framework to erase the database and mark it for deletion.

Syntax

PIBIO_STORAGE_ERASE_DATABASE_FN PibioStorageEraseDatabaseFn;

HRESULT PibioStorageEraseDatabaseFn(
  [in, out] PWINBIO_PIPELINE Pipeline,
  [in]      PWINBIO_UUID DatabaseId,
  [in]      LPCWSTR FilePath,
  [in]      LPCWSTR ConnectString
)
{...}

Parameters

[in, out] Pipeline

Pointer to the WINBIO_PIPELINE structure associated with the biometric unit performing the operation.

[in] DatabaseId

A pointer to a GUID that uniquely identifies the database. This is the same GUID used to register the database in the registry.

[in] FilePath

Pointer to a NULL-terminated UNICODE string that contains the fully qualified file path for the database.

[in] ConnectString

A pointer to a NULL-terminated UNICODE connection string for the database.

Return value

If the function succeeds, it returns S_OK. If the function fails, it must return one of the following HRESULT values to indicate the error.

Return code	Description
E_POINTER	A mandatory pointer argument is NULL.
WINBIO_E_DATABASE_CORRUPTED	The DatabaseId parameter is not the same as the one used when creating the database.
WINBIO_E_DATABASE_CANT_FIND	The specified database cannot be found.
WINBIO_E_INVALID_DEVICE_STATE	The StorageContext member of the pipeline object is NULL.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	winbio_adapter.h (include Winbio_adapter.h)

See also

Plug-in Functions

StorageAdapterCloseDatabase

StorageAdapterCreateDatabase

StorageAdapterOpenDatabase