WdfUsbTargetPipeIsInEndpoint function

[Applies to KMDF and UMDF]

The WdfUsbTargetPipeIsInEndpoint method determines whether a specified USB pipe is connected to an input endpoint.

Syntax

BOOLEAN WdfUsbTargetPipeIsInEndpoint(
  WDFUSBPIPE Pipe
);

Parameters

Pipe

A handle to a framework pipe object that represents a bulk pipe or interrupt pipe and was obtained by calling WdfUsbInterfaceGetConfiguredPipe.

Return Value

WdfUsbTargetPipeIsInEndpoint returns TRUE if the pipe that the Pipe handle represents is an input endpoint. The method returns FALSE if the endpoint is an output endpoint.

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

Remarks

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

Examples

The following code example determines whether a specified USB pipe is connected to an input endpoint.

BOOLEAN isInEndPoint;

isInEndPoint = WdfUsbTargetPipeIsInEndpoint(usbPipe);

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

WDF_USB_PIPE_DIRECTION_IN

WdfUsbInterfaceGetConfiguredPipe

WdfUsbTargetPipeIsOutEndpoint