IWDFUsbInterface::RetrieveUsbPipeObject method (wudfusb.h)
[Warning: UMDF 2 is the latest version of UMDF and supersedes UMDF 1. All new UMDF drivers should be written using UMDF 2. No new features are being added to UMDF 1 and there is limited support for UMDF 1 on newer versions of Windows 10. Universal Windows drivers must use UMDF 2. For more info, see Getting Started with UMDF.]
The RetrieveUsbPipeObject method retrieves a USB pipe object for the specified pipe index.
Syntax
HRESULT RetrieveUsbPipeObject(
[in] UCHAR PipeIndex,
[out] IWDFUsbTargetPipe **ppPipe
);
Parameters
[in] PipeIndex
The index of the USB pipe object to retrieve.
[out] ppPipe
A pointer to a variable that receives a pointer to the IWDFUsbTargetPipe interface for the USB pipe object whose index is specified by PipeIndex.
Return value
RetrieveUsbPipeObject returns one of the following values:
Return code | Description |
---|---|
|
RetrieveUsbPipeObject successfully retrieved the USB pipe object. |
|
RetrieveUsbPipeObject encountered an allocation failure. |
|
This value corresponds to the error code that the WinUsb API returned. |
Remarks
A UMDF driver can call the methods of the IWDFUsbTargetPipe interface that the RetrieveUsbPipeObject method retrieves to obtain the type of pipe and other information.
Examples
For a code example of how to use theRetrieveUsbPipeObject method, see IWDFUsbInterface::GetNumEndPoints.
Requirements
Requirement | Value |
---|---|
End of support | Unavailable in UMDF 2.0 and later. |
Target Platform | Desktop |
Minimum UMDF version | 1.5 |
Header | wudfusb.h (include Wudfusb.h) |
DLL | WUDFx.dll |