WdfUsbInterfaceGetDescriptor-Funktion (wdfusb.h)
[Gilt für KMDF und UMDF]
Die WdfUsbInterfaceGetDescriptor-Methode ruft den USB-Schnittstellendeskriptor ab, der einer angegebenen alternativen Einstellung einer angegebenen USB-Schnittstelle zugeordnet ist.
Syntax
void WdfUsbInterfaceGetDescriptor(
[in] WDFUSBINTERFACE UsbInterface,
[in] UCHAR SettingIndex,
[out] PUSB_INTERFACE_DESCRIPTOR InterfaceDescriptor
);
Parameter
[in] UsbInterface
Ein Handle für ein USB-Schnittstellenobjekt, das durch Aufrufen von WdfUsbTargetDeviceGetInterface abgerufen wurde.
[in] SettingIndex
Ein Indexwert, der eine alternative Einstellung für die Schnittstelle identifiziert. Weitere Informationen zu alternativen Einstellungen finden Sie in der USB-Spezifikation.
[out] InterfaceDescriptor
Ein Zeiger auf eine vom Aufrufer zugewiesene USB_INTERFACE_DESCRIPTOR Struktur, die das Framework ausfüllt.
Rückgabewert
Keine
Bemerkungen
Wenn der SettingIndex-Wert ungültig ist, kann die USB_INTERFACE_DESCRIPTOR-Struktur ungültige Daten empfangen.
Eine Fehlerüberprüfung tritt auf, wenn der Treiber ein ungültiges Objekthandle bereitstellt.
Weitere Informationen zur WdfUsbInterfaceGetDescriptor-Methode und USB-E/A-Zielen finden Sie unter USB-E/A-Ziele.
Beispiele
Im folgenden Codebeispiel wird der Index für alternative Einstellungen für eine angegebene USB-Schnittstelle abgerufen. Anschließend ruft das Beispiel den USB-Schnittstellendeskriptor ab, der die aktuelle alternative Einstellung der USB-Schnittstelle darstellt.
BYTE settingIndex;
USB_INTERFACE_DESCRIPTOR interfaceDescriptor;
settingIndex = WdfUsbInterfaceGetConfiguredSettingIndex(
UsbInterface
);
WdfUsbInterfaceGetDescriptor(
UsbInterface,
settingIndex,
&interfaceDescriptor
);
Anforderungen
Anforderung | Wert |
---|---|
Zielplattform | Universell |
KMDF-Mindestversion | 1.0 |
UMDF-Mindestversion | 2.0 |
Kopfzeile | wdfusb.h (wdfusb.h einschließen) |
Bibliothek | Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF) |
IRQL | <=DISPATCH_LEVEL |
DDI-Complianceregeln | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), UsbKmdfIrql(kmdf), UsbKmdfIrql2(kmdf), UsbKmdfIrqlExplicit(kmdf) |