Hardware Dev Center

Collapse the table of content
Expand the table of content
Expand Minimize

WdfUsbTargetPipeGetInformation method

[Applies to KMDF and UMDF]

The WdfUsbTargetPipeGetInformation method retrieves information about a USB pipe and its endpoint.

Syntax


VOID WdfUsbTargetPipeGetInformation(
  [in]  WDFUSBPIPE                Pipe,
  [out] PWDF_USB_PIPE_INFORMATION PipeInformation
);

Parameters

Pipe [in]

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

PipeInformation [out]

A pointer to a caller-allocated WDF_USB_PIPE_INFORMATION structure that receives information about the pipe and endpoint.

Return value

None.

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

Remarks

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

Examples

The following code example initializes a WDF_USB_PIPE_INFORMATION structure and calls WdfUsbTargetPipeGetInformation.


WDF_USB_PIPE_INFORMATION pipeInfo;

WDF_USB_PIPE_INFORMATION_INIT(&pipeInfo);
WdfUsbTargetPipeGetInformation(
                               Pipe,
                               &pipeInfo
                               );

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_INFORMATION
WDF_USB_PIPE_INFORMATION_INIT
WdfUsbInterfaceGetConfiguredPipe

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft