PWINBIO_CAPTURE_CALLBACK回呼函式 (winbio.h)

發行項
03/13/2024

由 Windows 生物特徵辨識架構呼叫，以從異步 WinBioCaptureSampleWithCallback 函式傳回結果。用戶端應用程式必須實作此函式。

重要建議您從 Windows 8 開始，不再使用 PWINBIO_CAPTURE_CALLBACK/WinBioCaptureSampleWithCallback 組合。請改為執行下列動作：

實作 PWINBIO_ASYNC_COMPLETION_CALLBACK 函式，以在作業完成時接收通知。
呼叫 WinBioAsyncOpenSession 函式。在 CallbackRoutine 參數中傳遞回呼的位址。在 NotificationMethod 參數中傳遞WINBIO_ASYNC_NOTIFY_CALLBACK。擷取異步會話句柄。
使用異步會話句柄來呼叫 WinBioCaptureSample。作業完成時，Windows 生物特徵辨識架構會以結果配置並初始化 WINBIO_ASYNC_RESULT 結構，並使用結果結構的指標叫用回呼。
從回呼實作呼叫 WinBioFree ，以在您完成使用之後釋放 WINBIO_ASYNC_RESULT 結構。

語法

PWINBIO_CAPTURE_CALLBACK PwinbioCaptureCallback;

void PwinbioCaptureCallback(
  [in, optional] PVOID CaptureCallbackContext,
  [in]           HRESULT OperationStatus,
  [in]           WINBIO_UNIT_ID UnitId,
  [in]           PWINBIO_BIR Sample,
  [in]           SIZE_T SampleSize,
  [in]           WINBIO_REJECT_DETAIL RejectDetail
)
{...}

參數

[in, optional] CaptureCallbackContext

應用程式所定義的緩衝區指標，並傳遞至 WinBioCaptureSampleWithCallback 函式的 CaptureCallbackContext 參數。架構或生物特徵辨識單位不會修改緩衝區。您的應用程式可以使用數據來協助判斷要執行的動作，或維護生物特徵辨識擷取的其他資訊。

[in] OperationStatus

擷取作業傳回的錯誤碼。

[in] UnitId

生物特徵辨識單位標識碼。

[in] Sample

範例數據的指標。

[in] SampleSize

Sample 參數所指向之範例數據的大小，以位元組為單位。

[in] RejectDetail

若要執行作業，則為失敗的其他資訊。如需詳細資訊，請參閱＜備註＞。

傳回值

無

備註

目前，Windows 生物特徵辨識架構僅支持指紋讀取器。因此，如果作業失敗，並在 WINBIO_REJECT_DETAIL 常數中傳回其他資訊，它會是下列其中一個值：

WINBIO_FP_TOO_HIGH
WINBIO_FP_TOO_LOW
WINBIO_FP_TOO_LEFT
WINBIO_FP_TOO_RIGHT
WINBIO_FP_TOO_FAST
WINBIO_FP_TOO_SLOW
WINBIO_FP_POOR_QUALITY
WINBIO_FP_TOO_SKEWED
WINBIO_FP_TOO_SHORT
WINBIO_FP_MERGE_FAILURE

範例

下列程式代碼範例會呼叫 WinBioCaptureSampleWithCallback ，並將指標傳遞至自定義回呼函式 CaptureSampleCallback，以異步方式擷取範例。連結到Winbio.lib 靜態庫，並包含下列頭檔：

Windows.h
Stdio.h
Conio.h
Winbio.h

HRESULT CaptureSampleWithCallback(BOOL bCancel)
{
    HRESULT hr = S_OK;
    WINBIO_SESSION_HANDLE sessionHandle = NULL;

    // Connect to the system pool. 
    hr = WinBioOpenSession( 
            WINBIO_TYPE_FINGERPRINT,    // Service provider
            WINBIO_POOL_SYSTEM,         // Pool type
            WINBIO_FLAG_RAW,            // Raw access
            NULL,                       // Array of biometric unit IDs
            0,                          // Count of biometric unit IDs
            WINBIO_DB_DEFAULT,          // Default database
            &sessionHandle              // [out] Session handle
            );
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioOpenSession failed. hr = 0x%x\n", hr);
        goto e_Exit;
    }

    // Capture a biometric sample asynchronously.
    wprintf_s(L"\n Calling WinBioCaptureSampleWithCallback ");
    hr = WinBioCaptureSampleWithCallback(
            sessionHandle,                  // Open session handle
            WINBIO_NO_PURPOSE_AVAILABLE,    // Intended use of the sample
            WINBIO_DATA_FLAG_RAW,           // Sample format
            CaptureSampleCallback,          // Callback function
            NULL                            // Optional context
            );
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioCaptureSampleWithCallback failed. ");
        wprintf_s(L"hr = 0x%x\n", hr);
        goto e_Exit;
    }
    wprintf_s(L"\n Swipe the sensor ...\n");

    // Cancel the capture process if the bCancel flag is set.
    if (bCancel)
    {
        wprintf_s(L"\n Starting CANCEL timer...");
        Sleep( 7000 );

        wprintf_s(L"\n Calling WinBioCancel\n");
        hr = WinBioCancel( sessionHandle );
        if (FAILED(hr))
        {
            wprintf_s(L"\n WinBioCancel failed. hr = 0x%x\n", hr);
            goto e_Exit;
        }
    }

    // Wait for the asynchronous capture process to complete 
    // or be canceled.
    hr = WinBioWait( sessionHandle );
    if (FAILED(hr))
    {
        wprintf_s(L"\n WinBioWait failed. hr = 0x%x\n", hr);
    }

e_Exit:

    if (sessionHandle != NULL)
    {
        WinBioCloseSession(sessionHandle);
        sessionHandle = NULL;
    }

    wprintf_s(L"\n Press any key to exit...");
    _getch();

    return hr;
}

//------------------------------------------------------------------------
// The following function is the callback for WinBioCaptureSampleWithCallback.
// The function filters the response from the biometric subsystem and 
// writes a result to the console window.
//
VOID CALLBACK CaptureSampleCallback(
    __in_opt PVOID CaptureCallbackContext,
    __in HRESULT OperationStatus,
    __in WINBIO_UNIT_ID UnitId,
    __in_bcount(SampleSize) PWINBIO_BIR Sample,
    __in SIZE_T SampleSize,
    __in WINBIO_REJECT_DETAIL RejectDetail
    )
{
    UNREFERENCED_PARAMETER(CaptureCallbackContext);

    wprintf_s(L"\n CaptureSampleCallback executing");
    wprintf_s(L"\n Swipe processed - Unit ID: %d", UnitId);

    if (FAILED(OperationStatus))
    {
        if (OperationStatus == WINBIO_E_BAD_CAPTURE)
        {
            wprintf_s(L"\n Bad capture; reason: %d\n", RejectDetail);
         }
        else
        {
            wprintf_s(L"\n WinBioCaptureSampleWithCallback failed. ");
            wprintf_s(L" OperationStatus = 0x%x\n", OperationStatus);
        }
        goto e_Exit;
    }

    wprintf_s(L"\n Captured %d bytes.\n", SampleSize);

e_Exit:

    if (Sample != NULL)
    {
        WinBioFree(Sample);
        Sample = NULL;
    }
}

規格需求

需求	值
最低支援的用戶端	Windows 7 [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2008 R2 [僅限傳統型應用程式]
目標平台	Windows
標頭	winbio.h

另請參閱

WINBIO_REJECT_DETAIL常數

WinBioCaptureSampleWithCallback

共用方式為

PWINBIO_CAPTURE_CALLBACK回呼函式 (winbio.h)

語法

參數

傳回值

備註

範例

規格需求

另請參閱

意見反應

其他資源