PIBIO_ENGINE_ATTACH_FN funzione di callback (winbio_adapter.h)

Articolo
08/27/2023

Chiamato da Windows Biometric Framework quando viene aggiunta una scheda motore alla pipeline di elaborazione dell'unità biometrica. Lo scopo di questa funzione è eseguire qualsiasi inizializzazione necessaria per operazioni biometriche successive.

Sintassi

PIBIO_ENGINE_ATTACH_FN PibioEngineAttachFn;

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

Parametri

[in, out] Pipeline

Puntatore a una 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	L'argomento Pipeline non può essere NULL.
E_OUTOFMEMORY	Impossibile completare l'operazione a causa di memoria insufficiente.
WINBIO_E_INVALID_DEVICE_STATE	Il membro EngineContext della struttura WINBIO_PIPELINE a cui punta l'argomento Pipeline non è NULL o il membro EngineHandle non è impostato su INVALID_HANDLE_VALUE.

Commenti

Questa funzione viene chiamata prima che l'adattatore di archiviazione sia stato inizializzato per l'unità biometrica. Pertanto, questa funzione non deve chiamare alcuna funzione a cui fa riferimento la struttura WINBIO_STORAGE_INTERFACE puntata dal membro StorageInterface dell'oggetto pipeline.

Quando si implementa questa funzione, è necessario allocare e gestire tutte le risorse necessarie dall'adattatore e collegarli alla pipeline di unità biometriche. A tale scopo, allocare una struttura di WINBIO_ENGINE_CONTEXT privata nell'heap, inizializzarla e impostarne l'indirizzo nel membro EngineContext dell'oggetto pipeline.

Se si verifica un errore durante la creazione e l'inizializzazione delle risorse dell'adattatore del motore usate da questa funzione, è necessario eseguire qualsiasi pulizia necessaria prima di restituire.

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

Analogamente, se il campo EngineHandle non contiene INVALID_HANDLE_VALUE quando questa funzione viene chiamata, è necessario restituire WINBIO_E_INVALID_DEVICE_STATE.

Esempio

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

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

}

Requisiti


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)