WdfUsbTargetPipeGetInformation function (wdfusb.h)
[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
[in] Pipe
A handle to a framework pipe object that was obtained by calling WdfUsbInterfaceGetConfiguredPipe.
[out] PipeInformation
A pointer to a caller-allocated WDF_USB_PIPE_INFORMATION structure that receives information about the pipe and endpoint.
Return value
None
Remarks
A bug check occurs if the driver supplies an invalid object handle.
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
Requirement | Value |
---|---|
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(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), UsbKmdfIrql(kmdf), UsbKmdfIrql2(kmdf), UsbKmdfIrqlExplicit(kmdf) |