PIBIO_STORAGE_GET_DATABASE_SIZE_FN callback function (winbio_adapter.h)

Called by the Windows Biometric Framework to retrieve the database size and available space.

Syntax

PIBIO_STORAGE_GET_DATABASE_SIZE_FN PibioStorageGetDatabaseSizeFn;

HRESULT PibioStorageGetDatabaseSizeFn(
  [in, out] PWINBIO_PIPELINE Pipeline,
  [out]     PSIZE_T AvailableRecordCount,
  [out]     PSIZE_T TotalRecordCount
)
{...}

Parameters

[in, out] Pipeline

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

[out] AvailableRecordCount

Pointer to a variable that receives the number of unused record slots in the database.

[out] TotalRecordCount

Pointer to a variable that receives the number of valid records in 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_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