WDF_USB_CONTROL_SETUP_PACKET_INIT_FEATURE関数 (wdfusb.h)

[アーティクル]
08/08/2023

[KMDF と UMDF に適用]

WDF_USB_CONTROL_SETUP_PACKET_INIT_FEATURE関数は、デバイス機能を設定またはクリアする USB コントロール転送のWDF_USB_CONTROL_SETUP_PACKET構造体を初期化します。

構文

void WDF_USB_CONTROL_SETUP_PACKET_INIT_FEATURE(
  [out] PWDF_USB_CONTROL_SETUP_PACKET Packet,
  [in]  WDF_USB_BMREQUEST_RECIPIENT   BmRequestRecipient,
  [in]  USHORT                        FeatureSelector,
  [in]  USHORT                        Index,
  [in]  BOOLEAN                       SetFeature
);

パラメーター

[out] Packet

WDF_USB_CONTROL_SETUP_PACKET構造体へのポインター。

[in] BmRequestRecipient

WDF_USB_CONTROL_SETUP_PACKET構造体の Packet.bm.Request.Recipient メンバーに格納されるWDF_USB_BMREQUEST_RECIPIENT型指定の値。

[in] FeatureSelector

WDF_USB_CONTROL_SETUP_PACKET構造体の Packet.wValue.Value メンバーに格納される機能固有の値。

[in] Index

WDF_USB_CONTROL_SETUP_PACKET構造体の Packet.wIndex.Value メンバーに格納される機能固有のインデックス値。

[in] SetFeature

TRUE の場合、指定した機能が設定されることを示すブール値。 FALSE の場合、指定した機能はクリアされます。

戻り値

なし

解説

WDF_USB_CONTROL_SETUP_PACKET_INIT_FEATURE関数は、次の処理を行います。

WDF_USB_CONTROL_SETUP_PACKET構造体を 0 にします。
Packet.bm.Request.Type メンバーを BmRequestStandard に設定します。
Packet.bm.Request.Dir メンバーを BmRequestDeviceToDevice に設定します。
SetFeature 引数に基づいて、Packet.bRequest メンバーを "set feature" または "clear feature" 要求値に設定します。
WDF_USB_CONTROL_SETUP_PACKET_INIT_FEATURE関数の入力引数を使用して、他の構造体メンバーを設定します。

WDF_USB_CONTROL_SETUP_PACKET構造体を初期化するには、ドライバーは次のいずれかの関数を呼び出す必要があります。

WDF_USB_CONTROL_SETUP_PACKET_INIT
WDF_USB_CONTROL_SETUP_PACKET_INIT_CLASS
WDF_USB_CONTROL_SETUP_PACKET_INIT_FEATURE
WDF_USB_CONTROL_SETUP_PACKET_INIT_GET_STATUS
WDF_USB_CONTROL_SETUP_PACKET_INIT_VENDOR

例

次のコード例では、 WDF_USB_CONTROL_SETUP_PACKET 構造体を初期化します。

WDF_USB_CONTROL_SETUP_PACKET packet;

WDF_USB_CONTROL_SETUP_PACKET_INIT_FEATURE(
                                          &packet,
                                          BMREQUEST_TO_DEVICE,
                                          USB_DEVICE_DESCRIPTOR_TYPE,
                                          0,
                                          FALSE
                                          );

要件

要件	値
対象プラットフォーム	ユニバーサル
最小 KMDF バージョン	1.0
最小 UMDF バージョン	2.0
Header	wdfusb.h (Wdfusb.h を含む)