WdfRequestRetrieveOutputWdmMdl 関数 (wdfrequest.h)

  • [アーティクル]

[KMDF にのみ適用]

WdfRequestRetrieveOutputWdmMdl メソッドは、I/O 要求の出力バッファーを表すメモリ記述子リスト (MDL) を取得します。

構文

NTSTATUS WdfRequestRetrieveOutputWdmMdl(
  [in]  WDFREQUEST Request,
  [out] PMDL       *Mdl
);

パラメーター

[in] Request

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

[out] Mdl

MDL へのポインターを受け取る場所へのポインター。

戻り値

操作が成功した場合、WdfRequestRetrieveOutputWdmMdl はSTATUS_SUCCESSを返します。 それ以外の場合、このメソッドは次のいずれかの値を返す可能性があります。

リターン コード 説明
STATUS_INVALID_PARAMETER
 入力パラメーターが無効です。
STATUS_INVALID_DEVICE_REQUEST
 要求の種類が無効であるか、要求で バッファーされた I/O も直接 I/O も使用されていません。 データ バッファーにアクセスするためのサポートされているメソッドの詳細については、次の「解説」セクションを参照してください。
STATUS_INTERNAL_ERROR
 要求は既に完了しています。
STATUS_BUFFER_TOO_SMALL
 入力バッファーの長さは 0 です。
STATUS_INSUFFICIENT_RESOURCES
 メモリが不足しています。
 

このメソッドは、他の NTSTATUS 値も返す場合があります。

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

注釈

要求の出力バッファーは、ドライバーが要求の発信元に提供する情報 (ディスクからのデータなど) を受け取ります。 ドライバーは WdfRequestRetrieveOutputWdmMdl を呼び出して、読み取り要求またはデバイス I/O 制御要求を呼び出すことができますが、書き込み要求には呼び出しません (書き込み要求では出力データが提供されないため)。

WdfRequestRetrieveOutputWdmMdl メソッドは、バッファー化された I/O メソッドまたはデータ バッファーにアクセスするための直接 I/O メソッドを使用する I/O 要求の出力バッファーの MDL を取得します。 要求の I/O 制御コードが IRP_MJ_INTERNAL_DEVICE_CONTROLされている場合、または要求が別のカーネル モード ドライバーから送信された場合、 WdfRequestRetrieveOutputWdmMdl では 、バッファーされた I/O も直接 I/O も使用しない I/O 要求もサポートされます。

WdfRequestRetrieveOutputWdmMdl がSTATUS_SUCCESSを返す場合、ドライバーは出力バッファーを記述する MDL へのポインターを受け取ります。

ドライバーは、 I/O 要求の完了後に要求の MDL にアクセスすることはできません。

WdfRequestRetrieveOutputWdmdl の詳細については、「Framework-Based ドライバーでのデータ バッファーへのアクセス」を参照してください。

例

次のコード例は、I/O 要求の入力バッファーの MDL を取得する EvtIoRead コールバック関数の一部です。 WdfRequestRetrieveOutputWdmMdl の呼び出しが失敗した場合、ドライバーは WdfRequestRetrieveOutputWdmMdl が返すエラー状態で要求を完了します。

VOID 
MyDrvEvtIoRead(
    IN WDFQUEUE  Queue,
    IN WDFREQUEST  Request,
    IN size_t  Length
    )
{
    NTSTATUS  status;
    PMDL  mdl = NULL;
...
    status = WdfRequestRetrieveOutputWdmMdl(
                                            Request,
                                            &mdl
                                            );
    if (!NT_SUCCESS(status))
    {
        WdfRequestCompleteWithInformation(
                                          Request,
                                          status,
                                          0
                                          );
    }
...
}

要件

要件 値
対象プラットフォーム ユニバーサル
最小 KMDF バージョン 1.0
Header wdfrequest.h (Wdf.h を含む)
Library Wdf01000.sys (「Framework ライブラリのバージョン管理」を参照)。
IRQL <=DISPATCH_LEVEL
DDI コンプライアンス規則 DriverCreate(kmdf), InvalidReqAccess(kmdf), InvalidReqAccessLocal(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf) , MdlAfterReqCompletedIntIoctl(kmdf), MdlAfterReqCompletedIntIoctlA(kmdf), MdlAfterReqCompletedIoctl(kmdf), MdlAfterReqCompletedIoctlA(kmdf), MdlAfterReqCompletedRead(kmdf), MdlAfterReqCompletedReadA(kmdf), MdlAfterReqCompletedWrite(kmdf), OutputBufferAPI(kmdf)

こちらもご覧ください

WdfRequestRetrieveInputWdmMdl