Funzione WinBioEnumDatabases (winbio.h)

Articolo
08/27/2023

Enumera tutti i database registrati che corrispondono a un tipo specificato.

Sintassi

HRESULT WinBioEnumDatabases(
  [in]  WINBIO_BIOMETRIC_TYPE Factor,
  [out] WINBIO_STORAGE_SCHEMA **StorageSchemaArray,
  [out] SIZE_T                *StorageCount
);

Parametri

[in] Factor

Maschera di bit di flag WINBIO_BIOMETRIC_TYPE che specifica i tipi di unità biometrica da enumerare. Attualmente è supportato solo WINBIO_TYPE_FINGERPRINT .

[out] StorageSchemaArray

Indirizzo di una variabile che riceve un puntatore a una matrice di strutture WINBIO_STORAGE_SCHEMA che contengono informazioni su ogni database. Se la funzione non riesce, il puntatore è impostato su NULL. Se la funzione ha esito positivo, è necessario passare il puntatore a WinBioFree per rilasciare la memoria allocata internamente per la matrice.

[out] StorageCount

Puntatore a un valore che specifica il numero di strutture a cui punta il parametro StorageSchemaArray .

Valore restituito

Se la funzione ha esito positivo, restituisce S_OK. Se la funzione ha esito negativo, restituisce un valore HRESULT che indica l'errore. I valori possibili includono, ma non sono limitati a, quelli indicati nella tabella seguente. Per un elenco di codici di errore comuni, vedere Valori HRESULT comuni.

Codice restituito	Descrizione
E_INVALIDARG	La maschera di bit contenuta nel parametro Factor contiene uno o più bit di tipo non validi.
E_OUTOFMEMORY	Memoria insufficiente per completare la richiesta.
E_POINTER	I parametri StorageSchemaArray e StorageCount non possono essere NULL.

Commenti

Solo WINBIO_TYPE_FINGERPRINT è attualmente supportato nel parametro Factor .

Se le informazioni su più database vengono restituite nella matrice di strutture a cui punta il parametro StorageSchemaArray , i database non sono garantiti in alcun ordine specifico.

Al termine dell'uso delle strutture restituite al parametro StorageSchemaArray , è necessario chiamare WinBioFree per rilasciare la memoria allocata internamente per la matrice.

Esempio

L'esempio di codice seguente chiama WinBioEnumDatabases per enumerare i database biometrici nel sistema. L'esempio include anche una funzione, DisplayGuid, per visualizzare l'ID del database. Collegare alla libreria statica Winbio.lib e includere i file di intestazione seguenti:

Windows.h
Stdio.h
Conio.h
Winbio.h

HRESULT EnumDatabases( )
{
    // Declare variables.
    HRESULT hr = S_OK;
    PWINBIO_STORAGE_SCHEMA storageSchemaArray = NULL;
    SIZE_T storageCount = 0;
    SIZE_T index = 0;

    // Enumerate the databases.
    hr = WinBioEnumDatabases( 
            WINBIO_TYPE_FINGERPRINT,    // Type of biometric unit
            &storageSchemaArray,        // Array of database schemas
            &storageCount );            // Number of database schemas
    if (FAILED(hr))
    {
        wprintf_s(L"\nWinBioEnumDatabases failed. hr = 0x%x\n", hr);
        goto e_Exit;
    }

    // Display information for each database.
    wprintf_s(L"\nDatabases:\n");
    for (index = 0; index < storageCount; ++index)
    {
        wprintf_s(L"\n[%d]: \tBiometric factor: 0x%08x\n", 
                 index, 
                 storageSchemaArray[index].BiometricFactor );
        
        wprintf_s(L"\tDatabase ID: ");
        DisplayGuid(&storageSchemaArray[index].DatabaseId);
        wprintf_s(L"\n");

        wprintf_s(L"\tData format: ");
        DisplayGuid(&storageSchemaArray[index].DataFormat);
        wprintf_s(L"\n");

        wprintf_s(L"\tAttributes:  0x%08x\n", 
                 storageSchemaArray[index].Attributes);

        wprintf_s(L"\tFile path:   %ws\n", 
                 storageSchemaArray[index].FilePath );

        wprintf_s(L"\tCnx string:  %ws\n", 
                 storageSchemaArray[index].ConnectionString );

        wprintf_s(L"\n");
    }

e_Exit:
    if (storageSchemaArray != NULL)
    {
        WinBioFree(storageSchemaArray);
        storageSchemaArray = NULL;
    }

    wprintf_s(L"\nPress any key to exit...");
    _getch();

    return hr;
}


//------------------------------------------------------------------------
// The following function displays a GUID to the console window.
//
VOID DisplayGuid( __in PWINBIO_UUID Guid )
{
    wprintf_s(
        L"{%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X}",
        Guid->Data1,
        Guid->Data2,
        Guid->Data3,
        Guid->Data4[0],
        Guid->Data4[1],
        Guid->Data4[2],
        Guid->Data4[3],
        Guid->Data4[4],
        Guid->Data4[5],
        Guid->Data4[6],
        Guid->Data4[7]
        );
}

Requisiti

Requisito	Valore
Client minimo supportato	Windows 7 [solo app desktop]
Server minimo supportato	Windows Server 2008 R2 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	winbio.h (include Winbio.h)
Libreria	Winbio.lib
DLL	Winbio.dll

Vedi anche

WINBIO_STORAGE_SCHEMA

WinBioEnumBiometricUnits

WinBioEnumEnrollments

WinBioEnumServiceProviders

Condividi tramite