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

Chamado pela Estrutura Biométrica do Windows imediatamente antes de um adaptador de armazenamento ser removido do pipeline de processamento da unidade biométrica. A finalidade dessa função é liberar recursos específicos do adaptador anexados ao pipeline.

Sintaxe

PIBIO_STORAGE_DETACH_FN PibioStorageDetachFn;

HRESULT PibioStorageDetachFn(
  [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 parâmetro Pipeline não pode ser NULL.
WINBIO_E_INVALID_DEVICE_STATE	O campo StorageContext da estrutura WINBIO_PIPELINE não pode ser NULL.

Comentários

Para evitar vazamentos de memória, a implementação da função StorageAdapterDetach deve liberar a estrutura de WINBIO_STORAGE_CONTEXT privada apontada pelo membro StorageContext do pipeline, juntamente com outros recursos anexados ao contexto de armazenamento.

Se o campo StorageContext no objeto de pipeline 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.

Antes de retornar S_OK, essa função deve definir o campo StorageContext da estrutura WINBIO_PIPELINE como NULL e o campo StorageHandle como INVALID_HANDLE_VALUE.

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.

/////////////////////////////////////////////////////////////////////////////////////////
//
// StorageAdapterDetach
//
// Purpose:
//      Release adapter specific resources attached to the pipeline.
//
// Parameters:
//      Pipeline -  Pointer to a WINBIO_PIPELINE structure associated with 
//                  the biometric unit performing the operation.
//
static HRESULT
WINAPI
StorageAdapterDetach(
    __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_STORAGE_CONTEXT storageContext = 
           (PWINBIO_STORAGE_CONTEXT)Pipeline->StorageContext;

    // Verify the pipeline state.
    if (storageContext == NULL)
    {
        // The pipeline state is not valid. This function should never
        // be called if the storage context in the pipeline is already
        // closed.
        hr = WINBIO_E_INVALID_DEVICE_STATE;
        goto cleanup;
    }

    // Release any structures attached to the context block.
    StorageAdapterClearContext(Pipeline);

    // Close the database.
    StorageAdapterCloseDatabase(Pipeline);

    // Remove the context from the pipeline.
    Pipeline->StorageContext = NULL;
    Pipeline->StorageHandle = INVALID_HANDLE_VALUE;

    // Clear the result set. Depending on your implementation, this action
    // can be performed by the StorageAdapterClearContext function called
    // earlier.
    ResultSetCleanup(&storageContext->ResultSet);

    // Release the adapter context.
    _AdapterRelease( storageContext );
    storageContext = NULL;

cleanup:

    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

StorageAdapterAttach