WdfUsbTargetPipeFormatRequestForUrb 函式 (wdfusb.h)
[僅適用於 KMDF]
WdfUsbTargetPipeFormatRequestForUrb 方法會使用指定 URB 所描述的要求參數來建置指定 USB 管道的 USB 要求，但不會傳送要求。
語法
NTSTATUS WdfUsbTargetPipeFormatRequestForUrb(
WDFUSBPIPE PIPE,
[in] WDFREQUEST Request,
[in] WDFMEMORY UrbMemory,
[in, optional] PWDFMEMORY_OFFSET UrbMemoryOffset
);
參數
PIPE
呼叫 WdfUsbInterfaceGetConfiguredPipe 取得之架構管道物件的句柄。
[in] Request
架構要求物件的句柄。 如需詳細資訊，請參閱接下來的＜備註＞一節。
[in] UrbMemory
包含 URB 結構的架構記憶體物件的句柄。
如果驅動程式先前稱為 WdfUsbTargetDeviceCreateWithParameters 來建立 UsbDevice，驅動程式必須使用 WdfUsbTargetDeviceCreateUrb 或 WdfUsbTargetDeviceCreateIsochUrb 來建立此記憶體物件中包含的 URB。
[in, optional] UrbMemoryOffset
呼叫端配置的 WDFMEMORY_OFFSET 結構的指標，可提供選擇性的位元移和長度值。 架構會使用這些值來判斷 UrbMemory 所指定記憶體中 URB 的開頭位址。 如果此指標為 NULL，URB 位於 UrbMemory 記憶體的開頭。
傳回值
WdfUsbTargetPipeFormatRequestForUrb 會在作業成功時傳回 I/O 目標的完成狀態值。 否則，此方法可以傳回下列其中一個值：
| 傳回碼 | Description |
|---|---|
|
偵測到無效的參數。 |
|
記憶體不足。 |
|
指定的 UsbMemoryOffset 參數無效的位移。 |
|
要求參數所代表的 I/O 要求封包 (IRP) 沒有足夠的IO_STACK_LOCATION結構，可讓驅動程式轉送要求。 |
這個方法也可能傳回其他 NTSTATUS值。
如果驅動程式提供無效的物件句柄，就會發生錯誤檢查。
備註
使用 WdfUsbTargetPipeFormatRequestForUrb，後面接著 WdfRequestSend，以同步或異步方式傳送 USB 要求。 或者，使用 WdfUsbTargetPipeSendUrbSynchronously 方法來同步傳送要求。
架構不會檢查 USB 要求。 如果要求變更 USB 管道的狀態，架構將不會察覺變更。
您可以轉送驅動程式在 I/O 佇列中收到的 I/O 要求，也可以建立並傳送新的要求。
若要轉送驅動程式在 I/O 佇列中收到的 I/O 要求，請針對 WdfUsbTargetPipeFormatRequestForUrb 方法的 Request 參數指定收到的要求句柄。
若要建立新的 I/O 要求，請呼叫 WdfRequestCreate 預先配置要求物件。 提供 WdfUsbTargetPipeFormatRequestForUrb 方法 的 Request 參數的要求 句柄。 您可以呼叫 WdfRequestReuse 來重複使用要求物件，因此驅動程式的 EvtDriverDeviceAdd 回呼函式可以預先配置裝置的要求物件。
呼叫 WdfUsbTargetPipeFormatRequestForUrb 以格式化 I/O 要求之後，驅動程式必須呼叫 WdfRequestSend ，以同步或異步方式將要求傳送) 至 I/O 目標 (。
對使用相同要求 之 WdfUsbTargetPipeFormatRequestForUrb 的多個呼叫不會造成額外的資源配置。 因此，為了減少 WdfRequestCreate 將傳回STATUS_INSUFFICIENT_RESOURCES的機會，驅動程式的 EvtDriverDeviceAdd 回呼函式可以呼叫 WdfRequestCreate 來預先配置裝置的一或多個要求物件。 驅動程式後續可以重複使用 (呼叫 WdfRequestReuse) 、重新格式化 (呼叫 WdfUsbTargetPipeFormatRequestForUrb) ，然後重新傳送 (呼叫 WdfRequestSend) 每個要求物件，而不需在稍後呼叫 WdfRequestCreate 時產生STATUS_INSUFFICIENT_RESOURCES傳回值的風險。 如果參數值未變更，則針對重複使用的要求物件，對 WdfUsbTargetPipeFormatRequestForUrb 的所有後續呼叫都會傳回STATUS_SUCCESS。 (如果驅動程式每次未呼叫相同的要求格式方法，可能會配置其他資源。)
如需 I/O 要求完成之後取得狀態資訊的相關信息，請參閱 取得完成資訊。
如需 WdfUsbTargetPipeFormatRequestForUrb 方法和 USB I/O 目標的詳細資訊，請參閱 USB I/O 目標。
範例
下列程式代碼範例會建立代表 URB 的記憶體物件。 然後，此範例會初始化 URB、格式化包含 URB 的 USB 要求、註冊 CompletionRoutine 回呼函式，以及傳送要求。
URB urb;
PURB pUrb = NULL;
WDFMEMORY urbMemory
NTSTATUS status;
status = WdfMemoryCreate(
WDF_NO_OBJECT_ATTRIBUTES,
NonPagedPool,
0,
sizeof(struct _URB_GET_CURRENT_FRAME_NUMBER),
&urbMemory,
NULL
);
if (!NT_SUCCESS(status)){
return status;
}
pUrb = WdfMemoryGetBuffer(
urbMemory,
NULL
);
pUrb->UrbHeader.Length = (USHORT) sizeof(struct _URB_GET_CURRENT_FRAME_NUMBER);
pUrb->UrbHeader.Function = URB_FUNCTION_GET_CURRENT_FRAME_NUMBER;
pUrb->UrbGetCurrentFrameNumber.FrameNumber = 0;
status = WdfUsbTargetPipeFormatRequestForUrb(
pipe,
Request,
urbMemory,
NULL
);
if (!NT_SUCCESS(status)) {
goto Exit;
}
WdfRequestSetCompletionRoutine(
Request,
UrbCompletionRoutine,
pipe
);
if (WdfRequestSend(
Request,
WdfUsbTargetPipeGetIoTarget(pipe),
WDF_NO_SEND_OPTIONS
) == FALSE) {
status = WdfRequestGetStatus(Request);
goto Exit;
}
Exit:
if (!NT_SUCCESS(status)) {
WdfRequestCompleteWithInformation(
Request,
status,
0
);
}
return;
規格需求
| 需求 | 值 |
|---|---|
| 目標平台 | Universal |
| 最小 KMDF 版本 | 1.0 |
| 標頭 | wdfusb.h (包含 Wdfusb.h) |
| 程式庫 | Wdf01000.sys (請參閱 Framework Library Versioning.) |
| IRQL | <=DISPATCH_LEVEL |
| DDI 合規性規則 | DriverCreate (kmdf) ， KmdfIrql (kmdf) ， KmdfIrql2 (kmdf ) ， KmdfIrqlExplicit (kmdf) ， RequestFormattedValid (kmdf) 、 RequestSendAndForgetNoFormatting (kmdf) 、 RequestSendAndForgetNoFormatting2 (kmdf) 、 UsbKmdfIrql (kmdf) 、 UsbKmdfIrql2 (kmdf) 、UsbKmdfIrqlExplicit (kmdf) |
另請參閱
WdfRequestCompleteWithInformation