PIBIO_SENSOR_CANCEL_FN

保留中のすべてのセンサー操作をキャンセルするために、Windows Biometric Framework から呼び出されます。

関数が成功した場合は S_OK を返します。関数が失敗した場合は、エラーを示すために次のいずれかの HRESULT 値を返す必要があります。

この関数の実装では、保留中の操作が完了するまで待機しないでください。

この関数が呼び出されたときにセンサーに保留中の操作がない場合、実装はパイプラインの状態を変更せずに S_OK を返す必要があります。

例

次の擬似コードは、この関数の実装方法の一例を示しています。この例はそのままではコンパイルできません。目的に合わせて調整する必要があります。

//////////////////////////////////////////////////////////////////////////////////////////
//
// SensorAdapterCancel
//
// 目的:
//      保留中のすべてのセンサー操作をキャンセルします。
//      
// パラメーター:
//      Pipeline -  バイオメトリック ユニットに関連付けられた WINBIO_PIPELINE
//                  構造体へのポインター。
//
static HRESULT
WINAPI
SensorAdapterCancel(
    __inout PWINBIO_PIPELINE Pipeline
    )
{
    HRESULT hr = S_OK;

    // Pipeline パラメーターが NULL でないことを確認します。
    if (!ARGUMENT_PRESENT(Pipeline))
    {
        hr = E_POINTER;
        goto cleanup;
    }

    // 現在のセンサーの状態を検証します。
    if (Pipeline->SensorHandle == INVALID_HANDLE_VALUE)
    {
        return WINBIO_E_INVALID_DEVICE_STATE;
    }

    // センサー ハンドルへのすべての I/O をキャンセルします。
    if (!CancelIoEx(Pipeline->SensorHandle, NULL))
    {
        hr = _SensorAdapterGetHresultFromWin32(GetLastError());
    }

    return hr;
}