IWDFUsbInterface::RetrieveUsbPipeObject method

[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

PipeIndex [in]

The index of the USB pipe object to retrieve.

ppPipe [out]

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 codeDescription
S_OK

RetrieveUsbPipeObject successfully retrieved the USB pipe object.

E_OUTOFMEMORY

RetrieveUsbPipeObject encountered an allocation failure.

An error code that is defined in Winerror.h

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

Target platform

Desktop

End of support

Unavailable in UMDF 2.0 and later.

Minimum UMDF version

1.5

Header

Wudfusb.h (include Wudfusb.h)

DLL

WUDFx.dll

See also

IWDFUsbInterface
IWDFUsbTargetPipe

 

 

Send comments about this topic to Microsoft

Show: