Expand Minimize

WdfUsbTargetPipeGetType method

[Applies to KMDF and UMDF]

The WdfUsbTargetPipeGetType method returns the type of a specified USB pipe.

Syntax


WDF_USB_PIPE_TYPE WdfUsbTargetPipeGetType(
  [in]  WDFUSBPIPE Pipe
);

Parameters

Pipe [in]

A handle to a framework pipe object that was obtained by calling WdfUsbInterfaceGetConfiguredPipe.

Return value

WdfUsbTargetPipeGetType returns a WDF_USB_PIPE_TYPE-typed value that identifies the specified pipe's type.

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

Remarks

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

Examples

The following code example determines the type of a USB pipe.


WDF_USB_PIPE_TYPEusbPipeType;

usbPipeType = WdfUsbTargetPipeGetType(usbPipe);
 

Requirements

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

WDF_USB_PIPE_TYPE
WdfUsbInterfaceGetConfiguredPipe

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft. All rights reserved.