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を返します。 それ以外の場合、このメソッドは次のいずれかの値を返すことができます。

リターン コード 説明
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
                                              );

要件

要件 値
対象プラットフォーム ユニバーサル
最小 KMDF バージョン 1.0
Header wdfusb.h (Wdfusb.h を含む)
Library Wdf01000.sys (「Framework ライブラリのバージョン管理」を参照)。
IRQL <=DISPATCH_LEVEL
DDI コンプライアンス規則 DriverCreate(kmdf)、 KmdfIrql(kmdf)、 KmdfIrql2(kmdf)、KmdfIrqlExplicit(kmdf)、 UsbKmdfIrql(kmdf)、 UsbKmdfIrql2(kmdf)、UsbKmdfIrqlExplicit(kmdf)

こちらもご覧ください

WdfUsbTargetDeviceCreateWithParameters