PIBIO_STORAGE_ATTACH_FN funzione di callback (winbio_adapter.h)

Articolo
08/27/2023

Chiamato da Windows Biometric Framework quando un adattatore di archiviazione viene aggiunto alla pipeline di elaborazione dell'unità biometrica. Lo scopo di questa funzione è eseguire qualsiasi inizializzazione necessaria per le operazioni biometriche successive.

Sintassi

PIBIO_STORAGE_ATTACH_FN PibioStorageAttachFn;

HRESULT PibioStorageAttachFn(
  [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 StorageContext della struttura WINBIO_PIPELINE a cui punta l'argomento Pipeline non è NULL o il membro StorageHandle non è impostato su INVALID_HANDLE_VALUE.

Commenti

Quando si implementa questa funzione, è necessario allocare e gestire le risorse richieste dall'adattatore e allegare queste risorse alla pipeline di unità biometriche. A tale scopo, allocare una struttura WINIBIO_STORAGE_CONTEXT privata nell'heap, inizializzarla e impostarne l'indirizzo nel membro StorageContext dell'oggetto pipeline.

Se il campo StorageContext non è NULL quando questa funzione viene chiamata, la pipeline non è stata reimpostata correttamente da una chiamata precedente a StorageAdapterDetach ed è necessario restituire WINBIO_E_INVALID_DEVICE_STATE per notificare a Windows Biometric Framework il problema.

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

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

Esempio

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

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

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

StorageAdapterDetach

Condividi tramite