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

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

Синтаксис

PIBIO_SENSOR_ATTACH_FN PibioSensorAttachFn;

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

Параметры

[in, out] Pipeline

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

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

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

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

Комментарии

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

Так как член SensorHandle структуры WINBIO_PIPELINE будет содержать допустимый дескриптор перед вызовом этого метода, реализация SensorAdapterAttach может использовать дескриптор для доступа к устройству датчика при необходимости.

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

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

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

Примеры

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

//////////////////////////////////////////////////////////////////////////////////////////
//
// SensorAdapterAttach
//
// 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
SensorAdapterAttach(
    __inout PWINBIO_PIPELINE Pipeline
    )
{
    HRESULT hr = S_OK;
    PWINBIO_SENSOR_CONTEXT newContext = NULL;

    // Verify that the Pipeline parameter is not NULL.
    if (!ARGUMENT_PRESENT(Pipeline))
    {
        hr = E_POINTER;
        goto cleanup;
    }

    // Validate the current sensor state.
    if (Pipeline->SensorContext != NULL)
    {
        hr = WINBIO_E_INVALID_DEVICE_STATE;
        goto cleanup;
    }

    // Use a custom function (_AdapterAlloc) to allocate memory for the 
    // sensor adapter context.
    newContext = (PWINBIO_SENSOR_CONTEXT)_AdapterAlloc(sizeof(WINBIO_SENSOR_CONTEXT));
    if (newContext == NULL)
    {
        hr = E_OUTOFMEMORY;
        goto cleanup;
    }

    // Create a manual reset event to monitor overlapped I/O.
    newContext->Overlapped.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
    if (newContext->Overlapped.hEvent == NULL)
    {
        hr = E_OUTOFMEMORY;
        goto cleanup;
    }

    // Initialize any required context fields. This example assumes that your
    // sensor context points to a capture buffer and an attributes buffer.
    newContext->CaptureBuffer = NULL;
    newContext->CaptureBufferSize = 0;

    newContext->AttributesBuffer = NULL;
    newContext->AttributesBufferSize = sizeof (WINBIO_SENSOR_ATTRIBUTES);

    // Transfer ownership of the new sensor context structure to the 
    // pipeline.
    Pipeline->SensorContext = newContext;
    newContext = NULL;

cleanup:

    if (FAILED(hr) && newContext != NULL)
    {
        CloseHandle( newContext->Overlapped.hEvent;
        _AdapterRelease( newContext );
        newContext = NULL;
    }
    return hr;
}

Требования

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

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

EngineAdapterAttach

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

SensorAdapterDetach

StorageAdapterAttach

WINBIO_PIPELINE