Função WinBioOpenSession (winbio.h)

Artigo
08/27/2023

Conecta-se a um provedor de serviços biométricos e a uma ou mais unidades biométricas.

Sintaxe

HRESULT WinBioOpenSession(
  [in]  WINBIO_BIOMETRIC_TYPE Factor,
  [in]  WINBIO_POOL_TYPE      PoolType,
  [in]  WINBIO_SESSION_FLAGS  Flags,
  [in]  WINBIO_UNIT_ID        *UnitArray,
  [in]  SIZE_T                UnitCount,
  [in]  GUID                  *DatabaseId,
  [out] WINBIO_SESSION_HANDLE *SessionHandle
);

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.

[in] PoolType

Um valor ULONG que especifica o tipo das unidades biométricas que serão usadas na sessão. Esse valor pode ser um dos seguintes:

Valor	Significado
WINBIO_POOL_SYSTEM	A sessão se conecta a uma coleção compartilhada de unidades biométricas gerenciadas pelo provedor de serviços.
WINBIO_POOL_PRIVATE	A sessão se conecta a uma coleção de unidades biométricas gerenciadas pelo chamador.

[in] Flags

Um valor ULONG que especifica as características de configuração de unidade biométrica e acesso para a nova sessão. Os sinalizadores de configuração especificam a configuração geral das unidades na sessão. Os sinalizadores de acesso especificam como o aplicativo usará as unidades biométricas. Você deve especificar um sinalizador de configuração, mas pode combinar esse sinalizador com qualquer sinalizador de acesso.

Valor	Significado
WINBIO_FLAG_DEFAULT	Grupo: configuração As unidades biométricas operam da maneira especificada durante a instalação. Você deve usar esse valor quando o parâmetro PoolType for WINBIO_POOL_SYSTEM.
WINBIO_FLAG_BASIC	Grupo: configuração As unidades biométricas funcionam apenas como dispositivos de captura básicos. Todas as operações de processamento, correspondência e armazenamento são executadas por plug-ins de software.
WINBIO_FLAG_ADVANCED	Grupo: configuração As unidades biométricas usam recursos internos de processamento e armazenamento.
WINBIO_FLAG_RAW	Grupo: acesso O aplicativo cliente captura dados biométricos brutos usando WinBioCaptureSample.
WINBIO_FLAG_MAINTENANCE	Grupo: acesso O cliente executa operações de controle definidas pelo fornecedor em uma unidade biométrica chamando WinBioControlUnitPrivileged.

[in] UnitArray

Ponteiro para uma matriz de identificadores de unidade biométrica a serem incluídos na sessão. Você pode chamar WinBioEnumBiometricUnits para enumerar as unidades biométricas. Defina esse valor como NULL se o parâmetro PoolType for WINBIO_POOL_SYSTEM.

[in] UnitCount

Um valor que especifica o número de elementos na matriz apontada pelo parâmetro UnitArray . Defina esse valor como zero se o parâmetro PoolType for WINBIO_POOL_SYSTEM.

[in] DatabaseId

Um valor que especifica os bancos de dados a serem usados pela sessão. Se o parâmetro PoolType for WINBIO_POOL_PRIVATE, você deverá especificar o GUID de um banco de dados instalado. Se o parâmetro PoolType não for WINBIO_POOL_PRIVATE, você poderá especificar um dos seguintes valores comuns.

Valor	Significado
WINBIO_DB_DEFAULT	Cada unidade biométrica no pool de sensores usa o banco de dados padrão especificado na configuração de unidade biométrica padrão. Você deve especificar esse valor se o parâmetro PoolType for WINBIO_POOL_SYSTEM. Você não poderá usar esse valor se o parâmetro PoolType for WINBIO_POOL_PRIVATE
WINBIO_DB_BOOTSTRAP	Você pode especificar esse valor a ser usado para cenários antes de iniciar o Windows. Normalmente, o banco de dados faz parte do chip do sensor ou faz parte do BIOS e só pode ser usado para registro e exclusão de modelo.
WINBIO_DB_ONCHIP	O banco de dados está no chip do sensor e está disponível para registro e correspondência.

[out] SessionHandle

Ponteiro para o novo identificador de sessão. Se a função não for bem-sucedida, o identificador será definido como zero.

Valor retornado

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	Um ou mais argumentos têm valores incorretos ou são incompatíveis com outros argumentos.
E_POINTER	O ponteiro do identificador de sessão no parâmetro SessionHandle não pode ser NULL.
E_ACCESSDENIED	O parâmetro Flags contém a WINBIO_FLAG_RAW ou o sinalizador WINBIO_FLAG_MAINTENANCE e o chamador não recebeu nenhuma permissão de acesso.
WINBIO_E_INVALID_UNIT	Um ou mais dos números de unidade biométrica especificados no parâmetro UnitArray não são válidos.
WINBIO_E_NOT_ACTIVE_CONSOLE	O aplicativo cliente está em execução em um cliente de área de trabalho remota e está tentando abrir uma sessão de pool do sistema.
WINBIO_E_SENSOR_UNAVAILABLE	O parâmetro PoolType é definido como WINBIO_POOL_PRIVATE e um ou mais dos sensores solicitados nesse pool não estão disponíveis.
WINBIO_E_DISABLED	A política administrativa atual proíbe o uso da API do Windows Biometric Framework.

Requisitos


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

WinBioCloseSession

Compartilhar via