Função WinBioEnumServiceProviders (winbio.h)

Recupera informações sobre provedores de serviço biométrico instalados. A partir do Windows 10, build 1607, essa função está disponível para uso com uma imagem móvel.

Sintaxe

HRESULT WinBioEnumServiceProviders(
  [in]  WINBIO_BIOMETRIC_TYPE Factor,
  [out] WINBIO_BSP_SCHEMA     **BspSchemaArray,
  [out] SIZE_T                *BspCount
);

Parâmetros

[in] Factor

Uma máscara de bits de sinalizadores de WINBIO_BIOMETRIC_TYPE que especifica os tipos de unidade biométrica a serem enumerados. Somente WINBIO_TYPE_FINGERPRINT tem suporte no momento.

[out] BspSchemaArray

Endereço de uma variável que recebe um ponteiro para uma matriz de estruturas de WINBIO_BSP_SCHEMA que contêm informações sobre cada um dos provedores de serviços disponíveis. Se a função não for bem-sucedida, o ponteiro será definido como NULL. Se a função for bem-sucedida, você deverá passar o ponteiro para WinBioFree para liberar a memória alocada internamente para a matriz.

[out] BspCount

Ponteiro para um valor que especifica o número de estruturas apontadas pelo parâmetro BspSchemaArray .

Retornar valor

Se a função for bem-sucedida, ela retornará S_OK. Se a função falhar, ela retornará um valor HRESULT que indica o erro. Os possíveis valores incluem, mas sem limitação, aqueles na tabela a seguir. Para obter uma lista de códigos de erro comuns, consulte Valores HRESULT comuns.

Código de retorno	Descrição
E_INVALIDARG	A máscara de bits contida no parâmetro Factor contém um ou mais bits de tipo inválidos.
E_OUTOFMEMORY	Não havia memória suficiente para concluir a solicitação.
E_POINTER	Os parâmetros BspSchemaArray e BspCount não podem ser NULL.

Comentários

Somente WINBIO_TYPE_FINGERPRINT atualmente tem suporte no parâmetro Factor .

Depois de terminar de usar as estruturas retornadas para o parâmetro BspSchemaArray , você deve chamar WinBioFree para liberar a memória alocada internamente para a matriz.

Se todos os bits de fator na máscara de bits Factor se referirem a tipos biométricos sem suporte, a função retornará S_OK mas o valor apontado pelo parâmetro BspSchemaArray será NULL e o parâmetro BspCount conterá zero. Embora não seja um erro perguntar sobre fatores biométricos sem suporte, o resultado da consulta será um conjunto vazio.

Exemplos

O exemplo de código a seguir chama WinBioEnumServiceProviders para enumerar os provedores de serviços instalados. O exemplo também inclui uma função, DisplayGuid, para exibir a ID do provedor. Link para a biblioteca estática Winbio.lib e inclua os seguintes arquivos de cabeçalho:

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

HRESULT EnumSvcProviders( )
{
    // Declare variables.
    HRESULT hr = S_OK;
    PWINBIO_BSP_SCHEMA bspSchemaArray = NULL;
    SIZE_T bspCount = 0;
    SIZE_T index = 0;

    // Enumerate the service providers.
    hr = WinBioEnumServiceProviders( 
            WINBIO_TYPE_FINGERPRINT,    // Provider to enumerate
            &bspSchemaArray,            // Provider schema array
            &bspCount );                // Number of schemas returned
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioEnumServiceProviders failed. hr = 0x%x\n", hr);
        goto e_Exit;
    }

    // Display the schema information.
    wprintf_s(L"\nService providers: \n");
    for (index = 0; index < bspCount; ++index)
    {
        wprintf_s(L"\n[%d]: \tBiometric factor: 0x%08x\n", 
                 index, 
                 bspSchemaArray[index].BiometricFactor );
        
        wprintf_s(L"\tBspId: ");
        DisplayGuid(&bspSchemaArray[index].BspId);
        wprintf_s(L"\n");

        wprintf_s(L"\tDescription: %ws\n", 
                 bspSchemaArray[index].Description);
        wprintf_s(L"\tVendor: %ws\n", 
                 bspSchemaArray[index].Vendor );
        wprintf_s(L"\tVersion: %d.%d\n", 
                 bspSchemaArray[index].Version.MajorVersion, 
                 bspSchemaArray[index].Version.MinorVersion);

        wprintf_s(L"\n");
    } 

e_Exit:
    if (bspSchemaArray != NULL)
    {
        WinBioFree(bspSchemaArray);
        bspSchemaArray = 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]
        );
}

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 7 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 R2 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winbio.h (inclua Winbio.h)
Biblioteca	Winbio.lib
DLL	Winbio.dll

Confira também

WinBioEnumBiometricUnits

WinBioEnumDatabases

WinBioEnumEnrollments