WdfIoTargetFormatRequestForRead 函式 (wdfiotarget.h)
[適用於 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。 否則，此方法可能會傳回下列其中一個值：
| 傳回碼 | Description |
|---|---|
|
偵測到無效的參數。 |
|
傳輸長度大於緩衝區長度，或 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 以預先配置一或多個要求物件。 您可以呼叫 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 來預先配置裝置的一或多個要求物件。 驅動程式後續可以重複使用 (呼叫 WdfRequestReuse) 、重新格式化 (呼叫 WdfIoTargetFormatRequestForRead) ，然後重新傳送 (呼叫 WdfRequestSend) 每個要求物件，而不會有STATUS_INSUFFICIENT_RESOURCES從稍後呼叫 WdfRequestCreate 傳回值的風險。 如果參數值未變更，則針對重複使用的要求物件，對 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);
}
規格需求
| 需求 | 值 |
|---|---|
| 目標平台 | Universal |
| 最小 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) |
另請參閱
WdfIoTargetFormatRequestForWrite
WdfIoTargetSendReadSynchronously