PIBIO_SENSOR_DETACH_FN funzione di callback (winbio_adapter.h)

Chiamato da Windows Biometric Framework immediatamente prima che un adattatore del sensore venga rimosso dalla pipeline di elaborazione dell'unità biometrica. Lo scopo di questa funzione è rilasciare risorse specifiche della scheda associate alla pipeline.

Sintassi

PIBIO_SENSOR_DETACH_FN PibioSensorDetachFn;

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

Parametri

[in, out] Pipeline

Puntatore alla struttura WINBIO_PIPELINE associata all'unità biometrica che esegue l'operazione.

Valore restituito

Se la funzione ha esito positivo, restituisce S_OK. Se la funzione ha esito negativo, deve restituire uno dei valori HRESULT seguenti per indicare l'errore.

Codice restituito Descrizione
E_POINTER
Il parametro Pipeline non può essere NULL.
WINBIO_E_INVALID_DEVICE_STATE
Il campo SensorContext della struttura WINBIO_PIPELINE non può essere NULL.

Commenti

Per evitare perdite di memoria, l'implementazione della funzione SensorAdapterDetach deve rilasciare la struttura privata WINBIO_SENSOR_CONTEXT puntata dal membro SensorContext della pipeline insieme ad altre risorse associate al contesto del sensore.

Se il campo SensorContext nell'oggetto pipeline è NULL quando questa funzione viene chiamata, la pipeline non è stata inizializzata correttamente e è necessario restituire WINBIO_E_INVALID_DEVICE_STATE per notificare il problema a Windows Biometric Framework.

Prima di restituire S_OK, questa funzione deve impostare il campo SensorContext della struttura WINBIO_PIPELINE su NULL.

Poiché questa funzione viene chiamata dopo che le schede del motore e di archiviazione sono state rimosse dalla pipeline, l'implementazione di questa funzione non deve chiamare alcuna funzione a cui fa riferimento la WINBIO_ENGINE_INTERFACEo WINBIO_STORAGE_INTERFACE strutture puntate dai membri EngineInterface e StorageInterface dell'oggetto pipeline.

Poiché il membro SensorHandle della struttura WINBIO_PIPELINE conterrà un handle valido anche dopo che SensorAdapterDetach viene chiamato, è possibile usare l'handle per accedere al dispositivo sensore, se necessario. Questa funzione non deve chiudere l'handle del sensore. Windows biometric Framework eseguirà questa operazione dopo la restituzione di SensorAdapterDetach .

Esempio

Lo pseudocode seguente mostra una possibile implementazione di questa funzione. L'esempio non viene compilato. Devi adattarla per adattarti al tuo scopo.

//////////////////////////////////////////////////////////////////////////////////////////
//
// 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;
}

Requisiti

Requisito Valore
Client minimo supportato Windows 7 [solo app desktop]
Server minimo supportato Windows Server 2008 R2 [solo app desktop]
Piattaforma di destinazione Windows
Intestazione winbio_adapter.h (includere Winbio_adapter.h)

Vedi anche

Funzioni plug-in

SensorAdapterAttach

WINBIO_PIPELINE