WdfUsbInterfaceGetEndpointInformation 関数 (wdfusb.h)

  • [アーティクル]

[KMDF と UMDF に適用]

WdfUsbInterfaceGetEndpointInformation メソッドは、指定された USB デバイス エンドポイントとそれに関連付けられているパイプに関する情報を取得します。

構文

void WdfUsbInterfaceGetEndpointInformation(
  [in]      WDFUSBINTERFACE           UsbInterface,
  [in]      UCHAR                     SettingIndex,
  [in]      UCHAR                     EndpointIndex,
  [in, out] PWDF_USB_PIPE_INFORMATION EndpointInfo
);

パラメーター

[in] UsbInterface

WdfUsbTargetDeviceGetInterface を呼び出すことによって取得された USB インターフェイス オブジェクトへのハンドル。

[in] SettingIndex

インターフェイスの代替設定を識別するインデックス値。 代替設定の詳細については、USB 仕様を参照してください。

[in] EndpointIndex

指定したインターフェイスの指定した代替設定に関連付けられているエンドポイントを識別するインデックス値。 (このインデックス値はエンドポイント アドレスではありません)。

[in, out] EndpointInfo

フレームワークが入力する呼び出し元によって割り当てられた WDF_USB_PIPE_INFORMATION 構造体へのポインター。

戻り値

なし

解説

ドライバーが無効なオブジェクト ハンドルを提供すると、バグ チェックが発生します。

WdfUsbInterfaceGetEndpointInformation メソッドと USB I/O ターゲットの詳細については、「USB I/O ターゲット」を参照してください。

例

次のコード例では、USB インターフェイスがサポートするエンドポイントの数を取得し、各エンドポイントの WdfUsbInterfaceGetEndpointInformation を呼び出します。

WDF_USB_PIPE_INFORMATION endPointInfo;
BYTE settingIndex, i;

settingIndex = 0;
numEndpoints = WdfUsbInterfaceGetNumEndpoints(
                                          UsbInterface,
                                          settingIndex
                                          );

for (i = 0; i < numEndpoints; i++){
    WDF_USB_PIPE_INFORMATION_INIT(&endPointInfo);
    WdfUsbInterfaceGetEndpointInformation(
                                          UsbInterface,
                                          settingIndex,
                                          i,
                                          &endPointInfo
                                          );

    //
    // Examine endpoint information here.
    //
...
}

要件

要件 値
対象プラットフォーム ユニバーサル
最小 KMDF バージョン 1.0
最小 UMDF バージョン 2.0
Header wdfusb.h (Wdfusb.h を含む)
Library Wdf01000.sys (KMDF);WUDFx02000.dll (UMDF)
IRQL <=DISPATCH_LEVEL
DDI コンプライアンス規則 DriverCreate(kmdf)、 KmdfIrql(kmdf)、 KmdfIrql2(kmdf)、KmdfIrqlExplicit(kmdf)、 UsbKmdfIrql(kmdf)、 UsbKmdfIrql2(kmdf)、UsbKmdfIrqlExplicit(kmdf)

こちらもご覧ください

WDF_USB_PIPE_INFORMATION

WdfUsbInterfaceGetNumEndpoints

WdfUsbTargetDeviceGetInterface