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

Chamado pela Estrutura Biométrica do Windows imediatamente antes que um adaptador de sensor seja 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_SENSOR_DETACH_FN PibioSensorDetachFn;

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

Parâmetros

[in, out] Pipeline

Ponteiro para a 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 SensorContext da estrutura WINBIO_PIPELINE não pode ser NULL.

Comentários

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

Se o campo SensorContext 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 SensorContext da estrutura WINBIO_PIPELINE como NULL.

Como essa função é chamada depois que os adaptadores de armazenamento e mecanismo foram removidos do pipeline, sua implementação dessa função não deve chamar nenhuma função referenciada pelo WINBIO_ENGINE_INTERFACE ou WINBIO_STORAGE_INTERFACE estruturas apontadas pelos membros EngineInterface e StorageInterface do objeto de pipeline.

Como o membro SensorHandle da estrutura WINBIO_PIPELINE conterá um identificador válido mesmo depois que SensorAdapterDetach for chamado, você pode usar o identificador para acessar o dispositivo do sensor, se necessário. Essa função não deve fechar o identificador do sensor. A Estrutura biométrica do Windows fará isso depois que SensorAdapterDetach 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.

//////////////////////////////////////////////////////////////////////////////////////////
//
// SensorAdapterDetach
//
// Purpose:
//      Cancels all pending sensor operations.
//      
// Parameters:
//      Pipeline -  Pointer to a WINBIO_PIPELINE structure associated with 
//                  the biometric unit.
//
static HRESULT
WINAPI
SensorAdapterDetach(
    __inout PWINBIO_PIPELINE Pipeline
    )
{
    PWINBIO_SENSOR_CONTEXT sensorContext = NULL;

    // Verify that the Pipeline parameter is not NULL.
    if (!ARGUMENT_PRESENT(Pipeline))
    {
        hr = E_POINTER;
        goto cleanup;
    }
 
    // Validate the current state of the sensor.
    if (Pipeline->SensorContext == NULL)
    {
        return WINBIO_E_INVALID_DEVICE_STATE;
    }

    // Cancel any pending I/O to the device.
    SensorAdapterCancel(Pipeline);

    // Take ownership of the sensor context from the pipeline.
    sensorContext = (PWINBIO_SENSOR_CONTEXT)Pipeline->SensorContext;
    Pipeline->SensorContext = NULL;

    // Release any structures that remain attached to the context block. 
    // The following example assumes that your sensor adapter context 
    // contains pointers to a capture buffer and an attributes buffer.
    if (sensorContext->CaptureBuffer != NULL)
    {
        // Zero the capture buffer.
        SecureZeroMemory(
            sensorContext->CaptureBuffer,
            sensorContext->CaptureBufferSize);

        // Release the capture buffer.
        _AdapterRelease(sensorContext->CaptureBuffer);
        sensorContext->CaptureBuffer = NULL;
        sensorContext->CaptureBufferSize = 0;
    }

    if (sensorContext->AttributesBuffer != NULL)
    {
        // Zero the attributes buffer.
        SecureZeroMemory(
            sensorContext->AttributesBuffer,
            sensorContext->AttributesBufferSize);

        // Release the attributes buffer.
        _AdapterRelease(sensorContext->AttributesBuffer);
        sensorContext->AttributesBuffer = NULL;
        sensorContext->AttributesBufferSize = 0;
    }

    // Close the overlapped I/O event handle.
    CloseHandle(sensorContext->Overlapped.hEvent);

    // Release the context structure.
    _AdapterRelease(sensorContext);
    sensorContext = NULL;
   
    return S_OK;
}

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

SensorAdapterAttach

WINBIO_PIPELINE