PIBIO_ENGINE_ATTACH_FN función de devolución de llamada (winbio_adapter.h)

Artículo
08/27/2023

Llamado por Windows Biometric Framework cuando se agrega un adaptador de motor a la canalización de procesamiento de la unidad biométrica. El propósito de esta función es realizar cualquier inicialización necesaria para las operaciones biométricas posteriores.

Sintaxis

PIBIO_ENGINE_ATTACH_FN PibioEngineAttachFn;

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

Parámetros

[in, out] Pipeline

Puntero a una estructura de WINBIO_PIPELINE asociada a la unidad biométrica que realiza la operación.

Valor devuelto

Si la función se ejecuta correctamente, devuelve S_OK. Si se produce un error en la función, debe devolver uno de los siguientes valores HRESULT para indicar el error.

Código devuelto	Descripción
E_POINTER	El argumento Pipeline no puede ser NULL.
E_OUTOFMEMORY	No se pudo completar la operación debido a memoria insuficiente.
WINBIO_E_INVALID_DEVICE_STATE	El miembro EngineContext de la estructura WINBIO_PIPELINE a la que apunta el argumento Pipeline no es NULL o el miembro EngineHandle no está establecido en INVALID_HANDLE_VALUE.

Comentarios

Se llama a esta función antes de que se haya inicializado el adaptador de almacenamiento para la unidad biométrica. Por lo tanto, esta función no debe llamar a ninguna función a la que hace referencia la estructura WINBIO_STORAGE_INTERFACE a la que apunta el miembro StorageInterface del objeto de canalización.

Al implementar esta función, debe asignar y administrar los recursos requeridos por el adaptador y adjuntarlos a la canalización de unidades biométricas. Para ello, asigne una estructura de WINBIO_ENGINE_CONTEXT privada en el montón, inicialícela y establezca su dirección en el miembro EngineContext del objeto de canalización.

Si se produce un error durante la creación e inicialización de los recursos del adaptador de motor usados por esta función, debe realizar cualquier limpieza necesaria antes de devolverla.

Si el campo EngineContext no es NULL cuando se llama a esta función, la canalización no se inicializó correctamente y debe devolver WINBIO_E_INVALID_DEVICE_STATE para notificar al marco biométrico de Windows del problema.

Del mismo modo, si el campo EngineHandle no contiene INVALID_HANDLE_VALUE cuando se llama a esta función, debe devolver WINBIO_E_INVALID_DEVICE_STATE.

Ejemplos

El siguiente pseudocódigo muestra una posible implementación de esta función. El ejemplo no se compila. Debes adaptarlo para que se adapte a tu propósito.

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

}

Requisitos


Cliente mínimo compatible	Windows 7 [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2008 R2 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winbio_adapter.h (incluya Winbio_adapter.h)