WdfUsbTargetDeviceRetrieveCurrentFrameNumber 函式 (wdfusb.h)

  • 發行項

[僅適用於 KMDF]

WdfUsbTargetDeviceRetrieveCurrentFrameNumber 方法會擷取目前的 USB 畫面編號。

語法

NTSTATUS WdfUsbTargetDeviceRetrieveCurrentFrameNumber(
  [in]  WDFUSBDEVICE UsbDevice,
  [out] PULONG       CurrentFrameNumber
);

參數

[in] UsbDevice

從先前呼叫 WdfUsbTargetDeviceCreateWithParameters 取得的 USB 裝置物件的句柄。

[out] CurrentFrameNumber

接收目前 32 位 USB 框架編號之位置的指標。

傳回值

WdfUsbTargetDeviceRetrieveCurrentFrameNumber 會在作業成功時傳回STATUS_SUCCESS。 否則，這個方法可以傳回下列其中一個值：

傳回碼 Description
STATUS_INVALID_PARAMETER
 偵測到無效的參數。
STATUS_UNSUCCESSFUL
 框架編號無法使用，可能是因為較低的驅動程式不提供框架編號。
 

這個方法也可能傳回其他 NTSTATUS值。

如果驅動程式提供無效的物件句柄，就會發生錯誤檢查。

備註

如需 WdfUsbTargetDeviceRetrieveCurrentFrameNumber 方法和 USB I/O 目標的詳細資訊，請參閱 USB I/O 目標。

範例

下列程式代碼範例會呼叫 WdfUsbTargetDeviceRetrieveCurrentFrameNumber。 此範例會從驅動程式定義的內容空間取得 USB 裝置物件句柄。

ULONG  frameNumber;
PMY_DEVICE_CONTEXT  pMyDeviceContext;

pMyDeviceContext = GetDeviceContext(Device);

status = WdfUsbTargetDeviceRetrieveCurrentFrameNumber(
                                              pMyDeviceContext->UsbTargetDevice,
                                              &frameNumber
                                              );

規格需求

需求 值
目標平台 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) ， UsbKmdfIrql (kmdf) 、 UsbKmdfIrql2 (kmdf) 、UsbKmdfIrqlExplicit (kmdf)

另請參閱

WdfUsbTargetDeviceCreateWithParameters