WdfIoTargetFormatRequestForWrite 関数 (wdfiotarget.h)

[アーティクル]
08/08/2023

[KMDF と UMDF に適用]

WdfIoTargetFormatRequestForWrite メソッドは、I/O ターゲットの書き込み要求を作成しますが、要求は送信しません。

構文

NTSTATUS WdfIoTargetFormatRequestForWrite(
  [in]           WDFIOTARGET       IoTarget,
  [in]           WDFREQUEST        Request,
  [in, optional] WDFMEMORY         InputBuffer,
  [in, optional] PWDFMEMORY_OFFSET InputBufferOffset,
  [in, optional] PLONGLONG         DeviceOffset
);

パラメーター

[in] IoTarget

WdfDeviceGetIoTarget または WdfIoTargetCreate の以前の呼び出し、または特殊化された I/O ターゲットが提供するメソッドから取得されたローカルまたはリモートの I/O ターゲットオブジェクトへのハンドル。

[in] Request

フレームワーク要求オブジェクトへのハンドル。詳細については、「解説」を参照してください。

[in, optional] InputBuffer

フレームワークメモリオブジェクトへのハンドル。このオブジェクトは、I/O ターゲットに送信されるデータを含むバッファーを表します。このパラメーターは省略可能であり、 NULL にすることができます。このパラメーターの詳細については、次の「解説」セクションを参照してください。

[in, optional] InputBufferOffset

省略可能なバイトオフセットと長さの値を提供する呼び出し元によって割り当てられた WDFMEMORY_OFFSET 構造体へのポインター。フレームワークでは、これらの値を使用して、入力バッファー内のデータ転送の開始アドレスと長さを決定します。このポインターが NULL の場合、データ転送は入力バッファーの先頭から開始され、転送サイズはバッファーサイズです。

[in, optional] DeviceOffset

転送の開始オフセットを指定する場所へのポインター。 I/O ターゲット (つまり、次の下位ドライバー) は、この値の使用方法を定義します。たとえば、ディスクのドライバースタック内のドライバーは、ディスクの先頭からのオフセットを指定する場合があります。 I/O ターゲットは、要求のWDF_REQUEST_PARAMETERS構造体の Parameters.Write.DeviceOffset メンバーでこの情報を取得します。このポインターは省略可能です。ほとんどのドライバーは、このポインターを NULL に設定 します。

戻り値

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

リターンコード	説明
STATUS_INVALID_PARAMETER	無効なパラメーターが検出されました。
STATUS_INVALID_DEVICE_REQUEST	転送長がバッファー長を超えているか、I/O 要求が既に I/O ターゲットにキューに入れられました。
STATUS_INSUFFICIENT_RESOURCES	フレームワークはシステムリソース (通常はメモリ) を割り当てませんでした。
STATUS_REQUEST_NOT_ACCEPTED	要求パラメーターが表す I/O 要求パケット (IRP) は、ドライバーが要求を転送できるようにするための十分なIO_STACK_LOCATION構造を提供しません。

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

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

注釈

WdfIoTargetFormatRequestForWrite メソッドの後に WdfRequestSend メソッドを使用して、書き込み要求を同期または非同期で送信します。または、 WdfIoTargetSendWriteSynchronously メソッドを使用して、書き込み要求を同期的に送信します。

ドライバーが I/O キューで受信した I/O 要求を転送することも、新しい要求を作成して送信することもできます。どちらの場合も、フレームワークには要求オブジェクトとバッファー領域が必要です。

ドライバーが I/O キューで受信した I/O 要求を転送するには:

WdfIoTargetFormatRequestForWrite メソッドの Request パラメーターに対して、受信した要求のハンドルを指定します。
WdfIoTargetFormatRequestForWrite メソッドの InputBuffer パラメーターには、受信した要求の入力バッファーを使用します。
ドライバーは WdfRequestRetrieveInputMemory を呼び出して、要求の入力バッファーを表すフレームワークメモリオブジェクトへのハンドルを取得し、そのハンドルを InputBuffer の値として使用する必要があります。

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

ドライバーは、多くの場合、受信した I/O 要求を、I/O ターゲットに送信する小さな要求に分割するため、ドライバーが新しい要求を作成する可能性があります。

新しい I/O 要求を作成するには:

新しい要求オブジェクトを作成し、 WdfIoTargetFormatRequestForWrite メソッドの Request パラメーターのハンドルを指定します。
WdfRequestCreate を呼び出して、1 つ以上の要求オブジェクトを事前割り当てします。これらの要求オブジェクトを再利用するには、 WdfRequestReuse を呼び出します。ドライバーの EvtDriverDeviceAdd コールバック関数は、デバイスの要求オブジェクトを事前割り当てできます。
バッファー領域を指定し、 WdfIoTargetFormatRequestForWrite メソッドの InputBuffer パラメーターのバッファーのハンドルを指定します。
ドライバーでは、フレームワークマネージドメモリへの WDFMEMORY ハンドルとしてこのバッファー領域を指定する必要があります。ドライバーは、次のいずれかを実行できます。
- ドライバーが新しいバッファーを I/O ターゲットに渡す場合は、 WdfMemoryCreate または WdfMemoryCreatePreallocated を呼び出して新しいメモリバッファーを作成します。
- WdfRequestRetrieveInputMemory を呼び出して、受信した I/O 要求のバッファーを表すメモリオブジェクトへのハンドルを取得します (ドライバーがそのバッファーの内容を I/O ターゲットに渡す場合)。
ドライバーが WdfRequestRetrieveInputMemory を呼び出し、メモリハンドルを WdfIoTargetFormatRequestForWrite に渡す場合、ドライバーは、ドライバーが新しいドライバー作成の要求オブジェクトを削除、再利用、または再フォーマットするまで、受信した I/O 要求を完了してはなりません。 (WdfIoTargetFormatRequestForWrite は、メモリオブジェクトの参照カウントをインクリメントします。要求オブジェクトを削除、再利用、または再フォーマットすると、メモリオブジェクトの参照カウントがデクリメントされます)。

一部の I/O ターゲットは、長さ 0 のバッファーを持つ書き込み要求を受け入れます。このような I/O ターゲットの場合、ドライバーは InputBuffer パラメーターに NULL を指定できます。

ドライバーが WdfIoTargetFormatRequestForWrite を呼び出して I/O 要求を書式設定した後、 WdfRequestSend を呼び出して要求を (同期的または非同期的に) I/O ターゲットに送信する必要があります。

同じ要求を使用する WdfIoTargetFormatRequestForWrite を 複数回呼び出しても、追加のリソース割り当ては発生しません。そのため、 WdfRequestCreate がSTATUS_INSUFFICIENT_RESOURCESを返す可能性を減らすために、ドライバーの EvtDriverDeviceAdd コールバック関数は WdfRequestCreate を呼び出して、デバイスの 1 つ以上の要求オブジェクトを事前割り当てできます。その後、ドライバーは WdfRequestCreate の後の呼び出しからSTATUS_INSUFFICIENT_RESOURCES戻り値を危険にさらすことなく、(WdfRequestReuse の呼び出し)、再フォーマット (WdfIoTargetFormatRequestForWrite の呼び出し)、および再送信 (WdfRequestSend の呼び出し) を行うことができます。再利用された要求オブジェクトに対する WdfIoTargetFormatRequestForWrite に対する後続のすべての呼び出しは、パラメーター値が変更されない場合、STATUS_SUCCESSを返します。 (ドライバーが毎回同じ要求書式設定メソッドを呼び出さない場合は、追加のリソースが割り当てられる可能性があります)。

I/O 要求の完了後に状態情報を取得する方法については、「完了情報の取得」を参照してください。

WdfIoTargetFormatRequestForWrite の詳細については、「一般的な I/O ターゲットへの I/O 要求の送信」を参照してください。

I/O ターゲットの詳細については、「I /O ターゲットの使用」を参照してください。

例

次のコード例では、書き込み要求の入力バッファー用のフレームワークメモリオブジェクトを作成し、書き込み要求の書式設定を行い、 CompletionRoutine コールバック関数を登録して、書き込み要求を I/O ターゲットに送信します。

WDFREQUEST  request;
NTSTATUS  status;
WDFMEMORY  memory;
WDF_OBJECT_ATTRIBUTES  attributes;

WDF_OBJECT_ATTRIBUTES_INIT(&attributes);
status = WdfMemoryCreate(
                         &attributes,
                         NonPagedPool,
                         DRIVER_TAG,
                         WRITE_BUF_SIZE,
                         &memory,
                         NULL
                         );

if (!NT_SUCCESS(status)) {
    return status;
}

status = WdfIoTargetFormatRequestForWrite(
                                          IoTarget,
                                          request,
                                          memory,
                                          NULL,
                                          NULL
                                          );
if (!NT_SUCCESS(status)) {
        return status;
}
WdfRequestSetCompletionRoutine(
                               request,
                               MyReadRequestCompletionRoutine,
                               targetInfo
                               );
if (WdfRequestSend(
                   request,
                   IoTarget,
                   WDF_NO_SEND_OPTIONS
                   ) == FALSE) {
        status = WdfRequestGetStatus(request);
}

要件

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