WdfUsbTargetDeviceGetDeviceDescriptor function (wdfusb.h)

Article
02/22/2024

[Applies to KMDF and UMDF]

The WdfUsbTargetDeviceGetDeviceDescriptor method retrieves the USB device descriptor for the USB device that is associated with a specified framework USB device object.

Syntax

void WdfUsbTargetDeviceGetDeviceDescriptor(
  [in]  WDFUSBDEVICE           UsbDevice,
  [out] PUSB_DEVICE_DESCRIPTOR UsbDeviceDescriptor
);

Parameters

[in] UsbDevice

A handle to a USB device object that was obtained from a previous call to WdfUsbTargetDeviceCreateWithParameters.

[out] UsbDeviceDescriptor

A pointer to a caller-allocated USB_DEVICE_DESCRIPTOR structure that receives the USB device descriptor.

Return value

None

Remarks

A bug check occurs if a driver-supplied object handle is invalid.

For more information about the WdfUsbTargetDeviceGetDeviceDescriptor method and USB I/O targets, see USB I/O Targets.

Examples

The following code example obtains the USB device descriptor for a device. The example stores the descriptor in driver-defined context space.

PMY_DEVICE_CONTEXT  myDeviceContext;

myDeviceContext = GetDeviceContext(device);

WdfUsbTargetDeviceGetDeviceDescriptor(
                                      myDeviceContext->UsbTargetDevice,
                                      &myDeviceContext->UsbDeviceDescr
                                      );

Requirements

Requirement	Value
Target Platform	Universal
Minimum KMDF version	1.0
Minimum UMDF version	2.0
Header	wdfusb.h (include Wdfusb.h)
Library	Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL	PASSIVE_LEVEL
DDI compliance rules	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), UsbKmdfIrql(kmdf), UsbKmdfIrql2(kmdf), UsbKmdfIrqlExplicit(kmdf)

Share via