PIBIO_ENGINE_ATTACH_FN回调函数 (winbio_adapter.h)

项目
08/27/2023

在将引擎适配器添加到生物识别单元的处理管道时由 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	Pipeline 参数指向的 WINBIO_PIPELINE 结构的 EngineContext 成员不是 NULL，或者 EngineHandle 成员未设置为 INVALID_HANDLE_VALUE。

注解

在为生物识别单元初始化存储适配器之前调用此函数。因此，此函数不得调用管道对象的 StorageInterface 成员所指向WINBIO_STORAGE_INTERFACE结构所引用的任何函数。

实现此函数时，必须分配和管理适配器所需的任何资源，并将其附加到生物识别单元管道。为此，请在堆上分配专用 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
标头	winbio_adapter.h (包括 Winbio_adapter.h)