WdfUsbInterfaceGetDescriptor 関数 (wdfusb.h)

[KMDF と UMDF に適用]

WdfUsbInterfaceGetDescriptor メソッドは、指定された USB インターフェイスの指定された代替設定に関連付けられている USB インターフェイス記述子を取得します。

構文

void WdfUsbInterfaceGetDescriptor(
  [in]  WDFUSBINTERFACE           UsbInterface,
  [in]  UCHAR                     SettingIndex,
  [out] PUSB_INTERFACE_DESCRIPTOR InterfaceDescriptor
);

パラメーター

[in] UsbInterface

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

[in] SettingIndex

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

[out] InterfaceDescriptor

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

戻り値

なし

解説

SettingIndex 値が無効な場合、USB_INTERFACE_DESCRIPTOR構造体は無効なデータを受け取る可能性があります。

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

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

例

次のコード例では、指定した USB インターフェイスの代替設定インデックスを取得します。 次に、USB インターフェイスの現在の代替設定を表す USB インターフェイス記述子を取得します。

BYTE  settingIndex;
USB_INTERFACE_DESCRIPTOR  interfaceDescriptor;

settingIndex = WdfUsbInterfaceGetConfiguredSettingIndex(
                             UsbInterface
                             );

WdfUsbInterfaceGetDescriptor(
                             UsbInterface,
                             settingIndex,
                             &interfaceDescriptor
                             );

要件

こちらもご覧ください

USB_INTERFACE_DESCRIPTOR

WdfUsbTargetDeviceGetInterface