[KMDF と UMDF に適用]
WdfIoTargetFormatRequestForRead メソッドは、I/O ターゲットの読み取り要求を作成しますが、要求は送信しません。
構文
NTSTATUS WdfIoTargetFormatRequestForRead(
[in] WDFIOTARGET IoTarget,
[in] WDFREQUEST Request,
[in, optional] WDFMEMORY OutputBuffer,
[in, optional] PWDFMEMORY_OFFSET OutputBufferOffset,
[in, optional] PLONGLONG DeviceOffset
);
パラメーター
[in] IoTarget
WdfDeviceGetIoTarget または WdfIoTargetCreate をする以前の呼び出しから取得されたローカルまたはリモートの I/O ターゲット オブジェクト、または特殊な I/O ターゲットが提供するメソッドからのハンドル。
[in] Request
フレームワーク要求オブジェクトへのハンドル。 詳細については、次の「解説」セクションを参照してください。
[in, optional] OutputBuffer
フレームワーク メモリ オブジェクトへのハンドル。 このオブジェクトは、I/O ターゲットからデータを受信するバッファーを表します。 このパラメーターは省略可能であり、NULL できます。 このパラメーターの詳細については、次の「解説」セクションを参照してください。
[in, optional] OutputBufferOffset
省略可能なバイト オフセットと長さの値を提供する呼び出し元によって割り当てられた WDFMEMORY_OFFSET 構造体へのポインター。 フレームワークでは、これらの値を使用して、出力バッファー内のデータ転送の開始アドレスと長さを決定します。 このポインターが NULL 場合、データ転送は出力バッファーの先頭から開始され、転送サイズはバッファー サイズになります。
[in, optional] DeviceOffset
転送の開始オフセットを指定する変数へのポインター。 I/O ターゲット (つまり、次の下位ドライバー) は、この値の使用方法を定義します。 たとえば、ディスクのドライバー スタック内のドライバーは、ディスクの先頭からのオフセットを指定する場合があります。 I/O ターゲットは、要求の WDF_REQUEST_PARAMETERS 構造体の Parameters.Read.DeviceOffset メンバーでこの情報を取得します。 このポインターは省略可能です。 ほとんどのドライバーは、このポインター NULLに設定します。
戻り値
WdfIoTargetFormatRequestForRead 、操作が成功した場合にSTATUS_SUCCESSを返します。 それ以外の場合、このメソッドは次のいずれかの値を返す可能性があります。
| リターン コード | 説明 |
|---|---|
|
無効なパラメーターが検出されました。 |
|
転送の長さがバッファー長より大きかったか、I/O 要求が既に I/O ターゲットにキューに入れられました。 |
|
フレームワークは、システム リソース (通常はメモリ) を割り当てませんでした。 |
|
要求 パラメーターが表す I/O 要求パケット (IRP) は、ドライバーが要求を転送するのに十分な IO_STACK_LOCATION 構造体を提供しません。 |
このメソッドは、他のNTSTATUS 値を返す場合もあります。
ドライバーが無効なオブジェクト ハンドルを提供すると、バグ チェックが発生します。
注釈
WdfIoTargetFormatRequestForRead メソッドの後に、WdfRequestSend メソッドを使用して、読み取り要求を同期的または非同期的に送信します。 または、WdfIoTargetSendReadSynchronously メソッドを使用して、読み取り要求を同期的に送信します。
ドライバーが I/O キューで受信した I/O 要求を転送することも、新しい要求を作成して送信することもできます。 どちらの場合も、フレームワークには要求オブジェクトとバッファー領域が必要です。
ドライバーが I/O キューで受信した I/O 要求を転送するには:
- WdfIoTargetFormatRequestForRead メソッドの Request パラメーターに対して、受信した要求のハンドルを指定します。
-
WdfIoTargetFormatRequestForRead メソッドの OutputBuffer パラメーターに対して、受信した要求の出力バッファーを使用します。
ドライバーは、要求の出力バッファーを表すフレームワーク メモリ オブジェクトへのハンドルを取得する WdfRequestRetrieveOutputMemory 呼び出す必要があり、OutputBufferの値としてそのハンドルを使用する必要があります。
ドライバーは、多くの場合、受信した I/O 要求を、I/O ターゲットに送信する小さな要求に分割するため、ドライバーは新しい要求を作成する可能性があります。
新しい I/O 要求を作成するには:
-
新しい要求オブジェクトを作成し、WdfIoTargetFormatRequestForRead メソッドの Request パラメーターのハンドルを指定します。
WdfRequestCreate 呼び出して、1 つ以上の要求オブジェクトを事前割り当てします。 これらの要求オブジェクトは、WdfRequestReuseを呼び出すことによって再利用できます。 ドライバーの EvtDriverDeviceAdd コールバック関数は、デバイスの要求オブジェクトを事前割り当てできます。
-
バッファー領域を指定し、WdfIoTargetFormatRequestForRead メソッドの OutputBuffer パラメーターのバッファーのハンドルを指定します。
ドライバーは、フレームワークマネージド メモリへの WDFMEMORY ハンドルとしてこのバッファー領域を指定する必要があります。 ドライバーは、次のいずれかを実行できます。
- ドライバー I/O ターゲットに新しいバッファーを渡す場合は、WdfMemoryCreate を呼び出すか、WdfMemoryCreatePreallocated を して新しいメモリ バッファーを作成します。
- ドライバー I/O ターゲットにバッファーの内容を渡す場合は、WdfRequestRetrieveOutputMemory を呼び出して、受信した I/O 要求のバッファーを表すメモリ オブジェクトへのハンドルを取得します。
ドライバーは、WdfIoTargetFormatRequestForRead を呼び出して I/O 要求を書式設定した後、WdfRequestSend を呼び出して、要求を (同期的または非同期的に) I/O ターゲットに送信する必要があります。
同じ要求 使用する WdfIoTargetFormatRequestForRead を複数回呼び出しても、追加のリソース割り当ては発生しません。 そのため、WdfRequestCreate がSTATUS_INSUFFICIENT_RESOURCESを返す可能性を減らすために、ドライバーの EvtDriverDeviceAdd コールバック関数は、WdfRequestCreate を呼び出して、デバイスの 1 つ以上の要求オブジェクトを事前割り当てできます。 ドライバーは、後で WdfRequestReuse 呼び出し)、再フォーマット (WdfIoTargetFormatRequestForReadを呼び出す)、および各要求オブジェクトの再送信 (WdfRequestSend 呼び出し) を行うことができます。後で WdfRequestCreate をSTATUS_INSUFFICIENT_RESOURCES戻り値を危険にさらす必要はありません。 再利用された要求オブジェクトに対して WdfIoTargetFormatRequestForRead を 後続のすべての呼び出しは、パラメーター値が変更されない場合、STATUS_SUCCESSを返します。 (ドライバーが毎回同じ要求形式メソッドを呼び出さない場合は、追加のリソースが割り当てられる可能性があります)。
I/O 要求が完了した後の状態情報の取得については、「完了情報の取得を参照してください。
WdfIoTargetFormatRequestForRead の詳細については、「一般的な 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,
READ_BUF_SIZE,
&memory,
NULL
);
if (!NT_SUCCESS(status)) {
return status;
}
status = WdfIoTargetFormatRequestForRead(
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 |
| ヘッダー | wdfiotarget.h (Wdf.h を含む) |
| 図書館 | Wdf01000.sys (KMDF);WUDFx02000.dll (UMDF) |
| IRQL | <=DISPATCH_LEVEL |
| DDI コンプライアンス規則 を する | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), RequestFormattedValid(kmdf), RequestSendAndForgetNoFormatting(kmdf), RequestSendAndForgetNoFormatting2(kmdf) |
こちらもご覧ください
EvtDriverDeviceAdd の
WdfDeviceGetIoTarget の
WdfIoTargetCreate の
WdfIoTargetFormatRequestForWrite の
WdfIoTargetSendReadSynchronously を する
WdfMemoryCreatePreallocated の