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

Статья
03/09/2024

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

Синтаксис

PIBIO_STORAGE_ATTACH_FN PibioStorageAttachFn;

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

Параметры

[in, out] Pipeline

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

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

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

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

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

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

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

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

Примеры

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

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

Требования

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

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

Функции подключаемого модуля

StorageAdapterDetach

Поделиться через