PIBIO_SENSOR_DETACH_FN回呼函式 (winbio_adapter.h)

在從生物特徵辨識單位的處理管線中移除感測器適配卡之前，立即由 Windows 生物特徵辨識架構呼叫。 此函式的目的是要釋放附加至管線的配接器特定資源。

語法

PIBIO_SENSOR_DETACH_FN PibioSensorDetachFn;

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

參數

[in, out] Pipeline

與執行作業之生物特徵辨識單位相關聯的 WINBIO_PIPELINE 結構的指標。

傳回值

如果函式成功，則會傳回S_OK。 如果函式失敗，它必須傳回下列其中一個 HRESULT 值，以指出錯誤。

傳回碼	Description
E_POINTER	Pipeline 參數不可為 NULL。
WINBIO_E_INVALID_DEVICE_STATE	WINBIO_PIPELINE 結構的 SensorContext 字段不可為 NULL。

備註

若要防止記憶體流失，您的 SensorAdapterDetach 函式實作必須釋放管線的 SensorContext 成員所指向的私人WINBIO_SENSOR_CONTEXT結構，以及附加至感測器內容的任何其他資源。

如果在呼叫此函式時，管線物件中的 SensorContext 字段為 NULL ，則管線未正確初始化，而且您必須傳回 WINBIO_E_INVALID_DEVICE_STATE ，以通知 Windows 生物特徵辨識架構發生問題。

傳回S_OK之前，此函式必須將WINBIO_PIPELINE結構的 SensorContext 字段設定為 NULL。

由於此函式是在從管線中移除儲存和引擎配接器之後呼叫，所以此函式的實作不得呼叫管線物件之 EngineInterface 和 StorageInterface 成員所參考之WINBIO_ENGINE_INTERFACE或WINBIO_STORAGE_INTERFACE結構所參考的任何函式。

由於即使呼叫 SensorAdapterDetach 之後，WINBIO_PIPELINE 結構的 SensorHandle 成員仍會包含有效的句柄，因此您可以視需要使用句柄來存取感測器裝置。 此函式不應該關閉感測器句柄。 在 SensorAdapterDetach 傳回之後，Windows 生物特徵辨識架構將會這麼做。

範例

下列虛擬程式代碼顯示此函式的一個可能實作。 此範例不會編譯。 您必須調整它以符合您的用途。

//////////////////////////////////////////////////////////////////////////////////////////
//
// SensorAdapterDetach
//
// Purpose:
//      Cancels all pending sensor operations.
//      
// Parameters:
//      Pipeline -  Pointer to a WINBIO_PIPELINE structure associated with 
//                  the biometric unit.
//
static HRESULT
WINAPI
SensorAdapterDetach(
    __inout PWINBIO_PIPELINE Pipeline
    )
{
    PWINBIO_SENSOR_CONTEXT sensorContext = NULL;

    // Verify that the Pipeline parameter is not NULL.
    if (!ARGUMENT_PRESENT(Pipeline))
    {
        hr = E_POINTER;
        goto cleanup;
    }
 
    // Validate the current state of the sensor.
    if (Pipeline->SensorContext == NULL)
    {
        return WINBIO_E_INVALID_DEVICE_STATE;
    }

    // Cancel any pending I/O to the device.
    SensorAdapterCancel(Pipeline);

    // Take ownership of the sensor context from the pipeline.
    sensorContext = (PWINBIO_SENSOR_CONTEXT)Pipeline->SensorContext;
    Pipeline->SensorContext = NULL;

    // Release any structures that remain attached to the context block. 
    // The following example assumes that your sensor adapter context 
    // contains pointers to a capture buffer and an attributes buffer.
    if (sensorContext->CaptureBuffer != NULL)
    {
        // Zero the capture buffer.
        SecureZeroMemory(
            sensorContext->CaptureBuffer,
            sensorContext->CaptureBufferSize);

        // Release the capture buffer.
        _AdapterRelease(sensorContext->CaptureBuffer);
        sensorContext->CaptureBuffer = NULL;
        sensorContext->CaptureBufferSize = 0;
    }

    if (sensorContext->AttributesBuffer != NULL)
    {
        // Zero the attributes buffer.
        SecureZeroMemory(
            sensorContext->AttributesBuffer,
            sensorContext->AttributesBufferSize);

        // Release the attributes buffer.
        _AdapterRelease(sensorContext->AttributesBuffer);
        sensorContext->AttributesBuffer = NULL;
        sensorContext->AttributesBufferSize = 0;
    }

    // Close the overlapped I/O event handle.
    CloseHandle(sensorContext->Overlapped.hEvent);

    // Release the context structure.
    _AdapterRelease(sensorContext);
    sensorContext = NULL;
   
    return S_OK;
}

規格需求

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

另請參閱

外掛程式函式

SensorAdapterAttach

WINBIO_PIPELINE