função de retorno de chamada PIBIO_ENGINE_ATTACH_FN (winbio_adapter.h)

Artigo
08/27/2023

Chamado pela Estrutura Biométrica do Windows quando um adaptador de mecanismo é adicionado ao pipeline de processamento da unidade biométrica. A finalidade dessa função é executar qualquer inicialização necessária para operações biométricas posteriores.

Sintaxe

PIBIO_ENGINE_ATTACH_FN PibioEngineAttachFn;

HRESULT PibioEngineAttachFn(
  [in, out] PWINBIO_PIPELINE Pipeline
)
{...}

Parâmetros

[in, out] Pipeline

Ponteiro para uma estrutura WINBIO_PIPELINE associada à unidade biométrica que executa a operação.

Valor retornado

Se a função for bem-sucedida, ela retornará S_OK. Se a função falhar, ela deverá retornar um dos seguintes valores HRESULT para indicar o erro.

Código de retorno	Descrição
E_POINTER	O argumento Pipeline não pode ser NULL.
E_OUTOFMEMORY	A operação não pôde ser concluída devido à memória insuficiente.
WINBIO_E_INVALID_DEVICE_STATE	O membro EngineContext da estrutura WINBIO_PIPELINE apontada pelo argumento Pipeline não é NULL ou o membro EngineHandle não está definido como INVALID_HANDLE_VALUE.

Comentários

Essa função é chamada antes que o adaptador de armazenamento seja inicializado para a unidade biométrica. Portanto, essa função não deve chamar nenhuma função referenciada pela estrutura WINBIO_STORAGE_INTERFACE apontada pelo membro StorageInterface do objeto pipeline.

Ao implementar essa função, você deve alocar e gerenciar todos os recursos exigidos pelo adaptador e anexá-los ao pipeline de unidade biométrica. Para fazer isso, aloque uma estrutura de WINBIO_ENGINE_CONTEXT privada no heap, inicialize-a e defina seu endereço no membro EngineContext do objeto de pipeline.

Se houver um erro durante a criação e inicialização dos recursos do adaptador de mecanismo usados por essa função, você deverá executar qualquer limpeza necessária antes de retornar.

Se o campo EngineContext não for NULL quando essa função for chamada, o pipeline não foi inicializado corretamente e você deverá retornar WINBIO_E_INVALID_DEVICE_STATE para notificar a Estrutura Biométrica do Windows sobre o problema.

Da mesma forma, se o campo EngineHandle não contiver INVALID_HANDLE_VALUE quando essa função for chamada, você deverá retornar WINBIO_E_INVALID_DEVICE_STATE.

Exemplos

O pseudocódigo a seguir mostra uma possível implementação dessa função. O exemplo não é compilado. Você deve adaptá-lo para se adequar à sua finalidade.

//////////////////////////////////////////////////////////////////////////////////////////
//
// EngineAdapterAttach
//
// Purpose:
//      Performs any initialization required for later biometric operations.
//
// Parameters:
//      Pipeline -  Pointer to a WINBIO_PIPELINE structure associated with 
//                  the biometric unit performing the operation.
//
static HRESULT
WINAPI
EngineAdapterAttach(
    __inout PWINBIO_PIPELINE Pipeline
    )
{
    HRESULT hr = S_OK;

    // Verify that the Pipeline parameter is not NULL.
    if (!ARGUMENT_PRESENT(Pipeline))
    {
        hr = E_POINTER;
        goto cleanup;
    }

    // Retrieve the context from the pipeline.
    PWINBIO_ENGINE_CONTEXT newContext = NULL;

    // Call a custom function (_AdapterAlloc) to allocate memory to hold the 
    // engine adapter context.
    newContext = (PWINBIO_ENGINE_CONTEXT)_AdapterAlloc(sizeof(WINBIO_ENGINE_CONTEXT));
    if (newContext == NULL)
    {
        E_OUTOFMEMORY;
        goto cleanup;
    }

    // Clear the context memory.
    ZeroMemory(newContext, sizeof(WINBIO_ENGINE_CONTEXT));

    // Initialize any required context fields.
    newContext->SomeField = SomeSpecialValue;

    newContext->SomePointerField = _AdapterAlloc(sizeof(SOME_STRUCTURE));
    if (newContext->SomePointerField == NULL)
    {
        E_OUTOFMEMORY;
        goto cleanup;
    }

    // If your adapter supports software-based template hashing, implement the 
    // following custom function to open a SHA1 hash object handle and store 
    // the handle in the adapter context. Use Cryptography Next Generation (CNG) 
    // functions to create the SHA1 hash object.
    hr = _AdapterInitializeCrypto(newContext);
    if (FAILED(hr))
    {
        goto cleanup;
    }

    // If initialization completes successfully, attach the engine context to the 
    // processing pipeline of the biometric unit.
    Pipeline->EngineContext = newContext;
    newContext = NULL;

cleanup:
    if (FAILED(hr))
    {
        // If a new context has been created, release any memory 
        // pointed to by various data members in the context and 
        // then release the context. The following example assumes 
        // that your adapter contains a handle
        // for a hash object and a pointer to another object.
        if (newContext != NULL)
        {
            // Close any open CNG handles and release the hash object memory.
            _AdapterCleanupCrypto(newContext);

            // Release any other object pointed to by the context.
            if (newContext->SomePointerField != NULL)
            {
                _AdapterRelease(newContext->SomePointerField);
            }

            // Release the context
            _AdapterRelease(newContext);
        }
    }
    return hr;

}

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_adapter.h (inclua Winbio_adapter.h)