WdfRequestGetStatus 関数 (wdfrequest.h)

  • [アーティクル]

[KMDF と UMDF に適用]

WdfRequestGetStatus メソッドは、I/O 要求の状態を返します。

構文

NTSTATUS WdfRequestGetStatus(
  [in] WDFREQUEST Request
);

パラメーター

[in] Request

フレームワーク要求オブジェクトへのハンドル。

戻り値

WdfRequestGetStatus は NTSTATUS 値を返します。 返すことができる値の詳細については、次の「解説」セクションを参照してください。

ドライバーが無効なオブジェクト ハンドルを提供すると、バグ チェックが発生します。

注釈

WdfRequestGetStatus メソッドは、次のいずれかを返します。

  • WdfRequestSend へのドライバーの呼び出しが成功した場合、WdfRequestGetStatus は、指定された要求を完了するために WdfRequestComplete を呼び出すドライバーによって設定された状態値を返します。 ドライバーは通常、CompletionRoutine コールバック関数内から WdfRequestGetStatus を呼び出します。
  • ドライバーによる WdfRequestSend の呼び出しが失敗した場合、WdfRequestGetStatus は、フレームワークがエラーを説明するために設定した状態値を返します。 ドライバーは 、WdfRequestSend を 呼び出した直後に WdfRequestGetStatus を呼び出すことができます。
ドライバーが WdfRequestSend を呼び出すときに要求のWDF_REQUEST_SEND_OPTION_SYNCHRONOUS フラグを設定した場合、ドライバーは WdfRequestSend の呼び出しが成功するか失敗したかに関係なく、WdfRequestSend を呼び出した直後に WdfRequestGetStatus を呼び出すことができます。

要求の完了の詳細については、「 I/O 要求の完了」を参照してください。

例

次のコード例は、 KbFiltr サンプル ドライバーのものです。 この例では、I/O 要求を I/O ターゲットに送信します。 WdfRequestSend が失敗した場合、この例では WdfRequestGetStatus 戻り値を WdfRequestComplete への入力として使用します。

VOID
KbFilter_ForwardRequest(
    IN WDFREQUEST Request,
    IN WDFIOTARGET Target
    )
{
    WDF_REQUEST_SEND_OPTIONS options;
    BOOLEAN ret;
    NTSTATUS status;

    WDF_REQUEST_SEND_OPTIONS_INIT(
                                  &options,
                                  WDF_REQUEST_SEND_OPTION_SEND_AND_FORGET
                                  );

    ret = WdfRequestSend(
                         Request,
                         Target,
                         &options
                         );

    if (ret == FALSE) {
        status = WdfRequestGetStatus (Request);
        DebugPrint(("WdfRequestSend failed: 0x%x\n", status));
        WdfRequestComplete(
                           Request,
                           status
                           );
    }
    return;
}

要件

要件 値
対象プラットフォーム ユニバーサル
最小 KMDF バージョン 1.0
最小 UMDF バージョン 2.0
Header wdfrequest.h (Wdf.h を含む)
Library Wdf01000.sys (KMDF);WUDFx02000.dll (UMDF)
IRQL <=DISPATCH_LEVEL
DDI コンプライアンス規則 DriverCreate(kmdf)、 KmdfIrql(kmdf)、 KmdfIrql2(kmdf)、KmdfIrqlExplicit(kmdf)、 RequestGetStatusValid(kmdf)

こちらもご覧ください

CompletionRoutine

WdfRequestComplete

WdfRequestSend