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

Llamado por Windows Biometric Framework para recuperar el hash de la plantilla de inscripción completada en la canalización.

Sintaxis

PIBIO_ENGINE_GET_ENROLLMENT_HASH_FN PibioEngineGetEnrollmentHashFn;

HRESULT PibioEngineGetEnrollmentHashFn(
  [in, out] PWINBIO_PIPELINE Pipeline,
  [out]     PUCHAR *HashValue,
  [out]     PSIZE_T HashSize
)
{...}

Parámetros

[in, out] Pipeline

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

[out] HashValue

Dirección de la variable que recibe un puntero a una matriz de bytes que contiene el hash de la plantilla.

[out] HashSize

Puntero a una variable que recibe el tamaño, en bytes, del hash al que apunta el parámetro HashValue .

Valor devuelto

Si la función se realiza 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	Un parámetro de puntero obligatorio es NULL.
E_NOTIMPL	El adaptador del motor no admite la generación de hash de plantillas.
WINBIO_E_INVALID_DEVICE_STATE	La canalización no contiene una plantilla de inscripción completada.

Comentarios

La plantilla con hash de esta función debe ser la plantilla de inscripción completada que se almacenará en la base de datos cuando se llame a EngineAdapterCommitEnrollment . No debe aplicar un hash a uno de los ejemplos capturados intermedios.

El algoritmo usado para generar el hash de plantilla es el que seleccionó la llamada más reciente, en esta canalización, a EngineAdapterSetHashAlgorithm.

La memoria que contiene el hash es propiedad del adaptador del motor y la administra después de que la función EngineAdapterGetEnrollmentHash se devuelva correctamente. El adaptador del motor debe mantener válida la dirección del búfer hasta que Framework llame a cualquiera de las funciones siguientes:

• EngineAdapterClearContext
• EngineAdapterCommitEnrollment
• EngineAdapterDiscardEnrollment

El adaptador del motor también debe mantener un búfer hash independiente para cada canalización.

Ejemplos

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

//////////////////////////////////////////////////////////////////////////////////////////
//
// EngineAdapterGetEnrollmentHash
//
// Purpose:
//      Retrieves the hash of the completed enrollment template in the pipeline.
//
// Parameters:
//      Pipeline        - Pointer to a WINBIO_PIPELINE structure associated 
//                        with the biometric unit performing the operation
//      HashValue       - Contains the hash of the template
//      HashSize        - Size, in bytes, of the hash pointed to by the 
//                        HashValue parameter
//
static HRESULT
WINAPI
EngineAdapterGetEnrollmentHash(
    __inout PWINBIO_PIPELINE Pipeline,
    __out PUCHAR *HashValue,
    __out PSIZE_T HashSize
    )
{
    ////////////////////////////////////////////////////////////////////////////
    // Return E_NOTIMPL here if your adapter does not support template hashing.
    ////////////////////////////////////////////////////////////////////////////

    HRESULT hr = S_OK;

    // Verify that pointer arguments are not NULL.
    if (!ARGUMENT_PRESENT(Pipeline) ||
        !ARGUMENT_PRESENT(HashValue) ||
        !ARGUMENT_PRESENT(HashSize))
    {
        hr = E_POINTER;
        goto cleanup;
    }

    // Retrieve the context from the pipeline.
    PWINBIO_ENGINE_CONTEXT context = 
           (PWINBIO_ENGINE_CONTEXT)Pipeline->EngineContext;

    // Return if an enrollment is not in progress. This example assumes that 
    // an enrollment object is part of your engine context structure.
    if (context->Enrollment.InProgress != TRUE)
    {
        hr = WINBIO_E_INVALID_DEVICE_STATE;
        goto cleanup;
    }

    // Initialize the hash.
    *HashValue = NULL;
    *HashSize = 0;

    // If your engine adapter supports template hashing, call a custom function
    // (_AdapterGenerateHashForTemplate) to calculate the hash of the new
    // enrollment template. The hash value should be saved in the adapter
    // context.
    hr = _AdapterGenerateHashForTemplate(
                context,
                context->Enrollment.Template, 
                context->Enrollment.TemplateSize,
                context->HashBuffer,
                &context->HashSize
                );
    if (FAILED(hr))
    {
        goto cleanup;
    }

    // Return the hash to the caller.
    *HashValue = context->HashBuffer;
    *HashSize = context->HashSize;

cleanup:

    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)

Consulte también

Funciones de complemento