WdfUsbInterfaceGetNumConfiguredPipes method

[Applies to KMDF and UMDF]

The WdfUsbInterfaceGetNumConfiguredPipes method returns the number of pipes that are configured for a specified USB device interface.

Syntax


BYTE WdfUsbInterfaceGetNumConfiguredPipes(
  [in] WDFUSBINTERFACE UsbInterface
);

Parameters

UsbInterface [in]

A handle to a USB interface object that was obtained by calling WdfUsbTargetDeviceGetInterface.

Return value

WdfUsbInterfaceGetNumConfiguredPipes returns the number of pipes that are configured for the specified interface.

A bug check occurs if the driver supplies an invalid object handle.

Remarks

Your driver can call WdfUsbInterfaceGetNumConfiguredPipes after it has called WdfUsbTargetDeviceSelectConfig.

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

Examples

The following code example obtains the number of pipes that are configured for a specified USB interface.


BYTE pipeCount;

pipeCount = WdfUsbInterfaceGetNumConfiguredPipes(UsbInterface);

Requirements

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

<=DISPATCH_LEVEL

DDI compliance rules

DriverCreate, KmdfIrql, KmdfIrql2, UsbKmdfIrql, UsbKmdfIrql2

See also

WdfUsbTargetDeviceGetInterface
WdfUsbTargetDeviceSelectConfig

 

 

Send comments about this topic to Microsoft

Show: