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

Chamado pela Estrutura Biométrica do Windows quando um adaptador de armazenamento é 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_STORAGE_ATTACH_FN PibioStorageAttachFn;

HRESULT PibioStorageAttachFn(
  [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.

Retornar valor

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 StorageContext da estrutura WINBIO_PIPELINE apontada pelo argumento Pipeline não é NULL ou o membro StorageHandle não está definido como INVALID_HANDLE_VALUE.

Comentários

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 WINIBIO_STORAGE_CONTEXT privada no heap, inicialize-a e defina seu endereço no membro StorageContext do objeto de pipeline.

Se o campo StorageContext não for NULL quando essa função for chamada, o pipeline não foi redefinido corretamente por uma chamada anterior para StorageAdapterDetach 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 StorageHandle não contiver INVALID_HANDLE_VALUE quando essa função for chamada, você deverá retornar WINBIO_E_INVALID_DEVICE_STATE.

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

Exemplos

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

/////////////////////////////////////////////////////////////////////////////////////////
//
// StorageAdapterAttach
//
// 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
StorageAdapterAttach(
    __inout PWINBIO_PIPELINE Pipeline
    )
{
    HRESULT hr = S_OK;
    PWINBIO_STORAGE_CONTEXT newContext = NULL;

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

    if (Pipeline->StorageContext != NULL ||
        Pipeline->StorageHandle != INVALID_HANDLE_VALUE)
    { 
        // The pipeline state is not valid. This function should never
        // be called if the pipeline already contains a storage context
        // or a valid storage handle.
        hr = WINBIO_E_INVALID_DEVICE_STATE;
        goto cleanup;
    }

    // Call a custom function (_AdapterAlloc) to allocate memory to hold the 
    // sensor adapter context.
    newContext = (PWINBIO_STORAGE_CONTEXT)_AdapterAlloc(sizeof(WINBIO_STORAGE_CONTEXT));
    if (newContext == NULL)
    {
        hr = E_OUTOFMEMORY;
        goto cleanup;
    }

    // Call a custom function to initialize the result set to be used by the next 
    // query operation. Initialization typically requires that you clear the result set
    // of any previous query, mark the set as empty, and place the result set cursor
    // in a known state.
    // The result set is attached to the storage context so that it can persist from
    // one storage adapter call to the next.  
    hr = _ResultSetInitialize(&newContext->ResultSet);
    if (FAILED(hr))
    {
        goto cleanup;
    }

    // TODO: Initialize any other required context fields (not shown).


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

cleanup:

    if (FAILED(hr) && newContext != NULL)
    {
        _ResultSetCleanup(&newContext->ResultSet);
        _AdapterRelease( newContext );
        newContext = NULL;
    }
    return hr;
}

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

Confira também

Funções de plug-in

StorageAdapterDetach