| UID | title | description | old-location | tech.root | ms.date | keywords | ms.keywords | req.header | req.include-header | req.target-type | req.target-min-winverclnt | req.target-min-winversvr | req.kmdf-ver | req.umdf-ver | req.ddi-compliance | req.unicode-ansi | req.idl | req.max-support | req.namespace | req.assembly | req.type-library | req.lib | req.dll | req.irql | targetos | req.typenames | f1_keywords | topic_type | api_type | api_location | api_name | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NF:wudfusb.IWDFUsbTargetPipe.RetrievePipePolicy |
IWDFUsbTargetPipe::RetrievePipePolicy (wudfusb.h) |
The RetrievePipePolicy method retrieves a WinUsb pipe policy. |
wdf\iwdfusbtargetpipe_retrievepipepolicy.htm |
wdf |
02/26/2018 |
|
IWDFUsbTargetPipe interface,RetrievePipePolicy method, IWDFUsbTargetPipe.RetrievePipePolicy, IWDFUsbTargetPipe::RetrievePipePolicy, RetrievePipePolicy, RetrievePipePolicy method, RetrievePipePolicy method,IWDFUsbTargetPipe interface, UMDFUSBref_97c7b2db-213f-4cdd-8901-547af39b087e.xml, umdf.iwdfusbtargetpipe_retrievepipepolicy, wdf.iwdfusbtargetpipe_retrievepipepolicy, wudfusb/IWDFUsbTargetPipe::RetrievePipePolicy |
wudfusb.h |
Wudfusb.h |
Desktop |
1.5 |
Unavailable in UMDF 2.0 and later. |
WUDFx.dll |
Windows |
|
|
|
|
|
[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 RetrievePipePolicy method retrieves a WinUsb pipe policy.
The type of WinUsb pipe policy that the UMDF driver requests.
A pointer to a variable that, on input, contains the size, in bytes, of the buffer that RetrievePipePolicy supplies for Value. On output, this parameter contains the size that RetrievePipePolicy requires for Value.
A pointer that receives the buffer that contains the WinUsb pipe policy.
RetrievePipePolicy returns one of the following values:
| Return code | Description |
|---|---|
|
RetrievePipePolicy successfully retrieved the WinUsb pipe policy. |
|
RetrievePipePolicy encountered an allocation failure. |
|
This value corresponds to the error code that the WinUsb API returned. |
Pipe policy controls the behavior of the USB pipe (for example, time-outs, handling short packets, and so on).
For more information about valid policy types that a UMDF driver can pass for the PolicyType parameter and values that the framework returns, see the WinUsb_GetPipePolicy function.
For information about the behavior of the pipe policies, see WinUSB Functions for Pipe Policy Modification.
The RetrievePipePolicy method generates a UMDF request and synchronously sends the request to the I/O target.