WdfUsbTargetDeviceFormatRequestForCyclePort 函式 （wdfusb.h）
[僅適用於 KMDF]
WdfUsbTargetDeviceFormatRequestForCyclePort 方法會建置指定裝置所連結之埠的電源週期要求，但不會傳送要求。
語法
NTSTATUS WdfUsbTargetDeviceFormatRequestForCyclePort(
[in] WDFUSBDEVICE UsbDevice,
[in] WDFREQUEST Request
);
參數
[in] UsbDevice
從先前呼叫 WdfUsbTargetDeviceCreateWithParameters 取得之 USB 裝置物件的句柄。
[in] Request
架構要求物件的句柄。 如需詳細資訊，請參閱下列一節。
傳回值
WdfUsbTargetDeviceFormatRequestForCyclePort 會在作業成功時傳回STATUS_SUCCESS。 否則，這個方法可以傳回下列其中一個值：
| 傳回碼 | 描述 |
|---|---|
|
裝置的 USB 裝置無法使用。 |
|
記憶體不足。 |
此方法也可能 傳回其他NTSTATUS 值。
如果驅動程式提供無效的物件句柄，就會發生錯誤檢查。
言論
使用 WdfUsbTargetDeviceFormatRequestForCyclePort，後面接著 WdfRequestSend，以同步或異步方式傳送電源週期要求。 或者，使用 WdfUsbTargetDeviceCyclePortSynchronously 方法來同步傳送要求。
在驅動程式呼叫 WdfRequestSend之前，它必須呼叫 WdfIoTargetStop，而且必須 完成 或 取消 它已傳送至 I/O 目標的所有 I/O 要求。 驅動程式在迴圈要求完成之前，不得將額外的 I/O 要求傳送至 I/O 目標。
您可以轉送驅動程式在 I/O 佇列中收到的 I/O 要求，也可以建立並傳送新的要求。
若要轉送驅動程式在 I/O 佇列中接收的 I/O 要求，請為 WdfUsbTargetDeviceFormatRequestForCyclePort 方法的 Request 參數指定收到的要求句柄。
若要建立新的 I/O 要求，請呼叫 WdfRequestCreate 來預先配置要求物件。 為 WdfUsbTargetDeviceFormatRequestForCyclePort 方法的 Request 參數提供要求句柄。 您可以呼叫 WdfRequestReuse來重複使用要求物件。 驅動程式的 EvtDriverDeviceAdd 回呼函式可以預先配置裝置的要求物件。
呼叫 WdfUsbTargetDeviceFormatRequestForCyclePort 格式化 I/O 要求之後，驅動程式必須呼叫 WdfRequestSend，以同步或異步方式將要求傳送至 I/O 目標。 此呼叫 WdfRequestSend 必須在 IRQL = PASSIVE_LEVEL進行。
對 WdfUsbTargetDeviceFormatRequestForCyclePort 使用相同要求的多個呼叫不會造成額外的資源配置。 因此，為了減少 WdfRequestCreate 會傳回STATUS_INSUFFICIENT_RESOURCES的機會，您的驅動程式 EvtDriverDeviceAdd 回呼函式可以呼叫 WdfRequestCreate 預先配置裝置的一或多個要求物件。 驅動程式接著可以重複使用 （呼叫 WdfRequestReuse）、重新格式化 （呼叫 WdfUsbTargetDeviceFormatRequestForCyclePort），以及重新傳送 （call WdfRequestSend）每個要求物件 STATUS_INSUFFICIENT_RESOURCES，而不需要冒險從稍後呼叫 WdfRequestCreate。 如果參數值未變更，則所有後續呼叫 WdfUsbTargetDeviceFormatRequestForCyclePort 會傳回STATUS_SUCCESS。 （如果驅動程式每次未呼叫相同的要求格式化方法，可能會配置額外的資源。
如需 WdfUsbTargetDeviceFormatRequestForCyclePort 方法和 USB I/O 目標的詳細資訊，請參閱 USB I/O 目標。
例子
下列程式代碼範例會格式化 power-cycle 要求、註冊 CompletionRoutine 回呼函式，並將要求傳送至 I/O 目標。
status = WdfUsbTargetDeviceFormatRequestForCyclePort(
UsbDevice,
request
);
if (!NT_SUCCESS(status)){
return status;
}
WdfRequestSetCompletionRoutine(
request,
MyCompletionRoutine,
NULL
);
if (WdfRequestSend(
request,
WdfUsbTargetDeviceGetIoTarget(UsbDevice),
NULL
) == FALSE) {
status = WdfRequestGetStatus(request);
}
要求
| 要求 | 價值 |
|---|---|
| 目標平臺 | 普遍 |
| 最低 KMDF 版本 | 1.0 |
| 標頭 | wdfusb.h （包括 Wdfusb.h） |
| 連結庫 | Wdf01000.sys （請參閱架構連結庫版本控制。） |
| IRQL | <=DISPATCH_LEVEL |
| DDI 合規性規則 | DriverCreate（kmdf），KmdfIrql（kmdf），KmdfIrql2（kmdf），KmdfIrqlExplicit（kmdf），RequestFormattedValid（kmdf），RequestSendAndForgetNoFormatting（kmdf），RequestSendAndForgetNoFormatting2（kmdf），UsbKmdfIrql（kmdf），UsbKmdfIrql2（kmdf），UsbKmdfIrqlExplicit（kmdf） |