WdfRequestRetrieveUnsafeUserOutputBuffer 関数 (wdfrequest.h)

  • [アーティクル]

[KMDF にのみ適用]

WdfRequestRetrieveUnsafeUserOutputBuffer メソッドは、データ バッファーにアクセスするための要求の手法がバッファー化も直接 I/O でもない場合に、I/O 要求の出力バッファーを取得します。

構文

NTSTATUS WdfRequestRetrieveUnsafeUserOutputBuffer(
  [in]            WDFREQUEST Request,
  [in]            size_t     MinimumRequiredLength,
  [out]           PVOID      *OutputBuffer,
  [out, optional] size_t     *Length
);

パラメーター

[in] Request

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

[in] MinimumRequiredLength

ドライバーが I/O 要求を処理するために必要な最小バッファー サイズ (バイト単位)。

[out] OutputBuffer

バッファーのアドレスを受け取る場所へのポインター。

[out, optional] Length

バッファーのサイズをバイト単位で受け取る場所へのポインター。 このパラメーターは省略可能であり、 NULL にすることができます。

戻り値

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

リターン コード 説明
STATUS_INVALID_PARAMETER
 入力パラメーターが無効です。
STATUS_INVALID_DEVICE_REQUEST
 この値は、次のいずれかが発生した場合に返されます。
STATUS_BUFFER_TOO_SMALL
 MinimumRequiredLength パラメーターは、バッファーの実際のサイズより大きいバッファー サイズを指定します。
 

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

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

注釈

WdfRequestRetrieveUnsafeUserOutputBuffer メソッドは、EvtIoInCallerContext コールバック関数から呼び出す必要があります。 WdfRequestRetrieveUnsafeUserOutputBuffer を呼び出した後、ドライバーは WdfRequestProbeAndLockUserBufferForWrite を呼び出す必要があります。

要求の I/O コントロール コードがIRP_MJ_READまたはIRP_MJ_DEVICE_CONTROL場合、ドライバーは WdfRequestRetrieveUnsafeUserOutputBuffer を呼び出すことができます。

ドライバーは、Request パラメーターが表す I/O 要求が完了するまで、取得したバッファーにアクセスできます。

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

例

WdfRequestRetrieveUnsafeUserOutputBuffer を使用するコード例については、「WdfRequestProbeAndLockUserBufferForRead」を参照してください。

要件

要件 値
対象プラットフォーム ユニバーサル
最小 KMDF バージョン 1.0
Header wdfrequest.h (Wdf.h を含む)
Library Wdf01000.sys (「Framework ライブラリのバージョン管理」を参照)。
IRQL PASSIVE_LEVEL
DDI コンプライアンス規則 BufAfterReqCompletedIntIoctl(kmdf), BufAfterReqCompletedIntIoctlA(kmdf), BufAfterReqCompletedIoctl(kmdf), BufAfterReqCompletedIoctlA(kmdf), BufAfterReqCompletedRead(kmdf), BufAfterReqCompletedReadA(kmdf), BufAfterReqCompletedWrite(kmdf), DriverCreate(kmdf), InvalidReqAccess(kmdf), InvalidReqAccessLocal(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf),KmdfIrqlExplicit(kmdf), OutputBufferAPI(kmdf)

こちらもご覧ください

EvtIoInCallerContext

WdfRequestProbeAndLockUserBufferForWrite

WdfRequestRetrieveUnsafeUserInputBuffer