Expand Minimize

WdfUsbTargetPipeIsOutEndpoint method

[Applies to KMDF and UMDF]

The WdfUsbTargetPipeIsOutEndpoint method determines whether a specified USB pipe is connected to an output endpoint.

Syntax


BOOLEAN WdfUsbTargetPipeIsOutEndpoint(
  [in]  WDFUSBPIPE Pipe
);

Parameters

Pipe [in]

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

Return value

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

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

Remarks

For more information about the WdfUsbTargetPipeIsOutEndpoint 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 output endpoint.


BOOLEAN isOutEndPoint;

isOutEndPoint = WdfUsbTargetPipeIsOutEndpoint(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_DIRECTION_OUT
WdfUsbInterfaceGetConfiguredPipe
WdfUsbTargetPipeIsInEndpoint

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft