функция обратного вызова PIBIO_ENGINE_ATTACH_FN (winbio_adapter.h)

Вызывается биометрической платформой Windows при добавлении адаптера подсистемы в конвейер обработки биометрической единицы. Эта функция предназначена для выполнения любой инициализации, необходимой для последующих биометрических операций.

Синтаксис

PIBIO_ENGINE_ATTACH_FN PibioEngineAttachFn;

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

Параметры

[in, out] Pipeline

Указатель на структуру WINBIO_PIPELINE , связанную с биометрической единицей, выполняющей операцию.

Возвращаемое значение

Если функция выполняется успешно, она возвращает S_OK. Если функция завершается сбоем, она должна вернуть одно из следующих значений HRESULT , чтобы указать на ошибку.

Код возврата	Описание
E_POINTER	Аргумент Pipeline не может иметь значение NULL.
E_OUTOFMEMORY	Операция не может быть завершена из-за нехватки памяти.
WINBIO_E_INVALID_DEVICE_STATE	Элемент EngineContext структуры WINBIO_PIPELINE , на который указывает аргумент Pipeline, не имеет значения NULL или для элемента EngineHandle не задано значение INVALID_HANDLE_VALUE.

Комментарии

Эта функция вызывается до инициализации адаптера хранилища для биометрической единицы. Поэтому эта функция не должна вызывать функции, на которые ссылается структура WINBIO_STORAGE_INTERFACE , на которую указывает элемент StorageInterface объекта конвейера.

При реализации этой функции необходимо выделить все ресурсы, необходимые адаптеру, и управлять ими, а также присоединить их к конвейеру биометрических единиц. Для этого выделите частную структуру WINBIO_ENGINE_CONTEXT в куче, инициализируйте ее и задайте ее адрес в элементе EngineContext объекта конвейера.

Если во время создания и инициализации ресурсов адаптера подсистемы, используемых этой функцией, возникает ошибка, перед возвратом необходимо выполнить любую необходимую очистку.

Если при вызове этой функции поле EngineContext не равно NULL , конвейер не был инициализирован должным образом и необходимо вернуть WINBIO_E_INVALID_DEVICE_STATE , чтобы уведомить Биометрическую платформу Windows о проблеме.

Аналогичным образом, если поле EngineHandle не содержит INVALID_HANDLE_VALUE при вызове этой функции, необходимо вернуть WINBIO_E_INVALID_DEVICE_STATE.

Примеры

В следующем псевдокоде показана одна из возможных реализаций этой функции. Пример не компилируется. Вы должны адаптировать его в соответствии с вашей целью.

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

}

Требования

Минимальная версия клиента	Windows 7 [только классические приложения]
Минимальная версия сервера	Windows Server 2008 R2 [только классические приложения]
Целевая платформа	Windows
Header	winbio_adapter.h (включая Winbio_adapter.h)

См. также раздел

EngineAdapterDetach

Функции подключаемых модулей

SensorAdapterAttach

StorageAdapterAttach

WINBIO_PIPELINE