IWDFUsbTargetPipe::RetrievePipePolicy 方法 (wudfusb.h)

[警告: UMDF 2 是最新版本的 UMDF,取代了 UMDF 1。 所有新的 UMDF 驱动程序都应使用 UMDF 2 编写。 没有将新功能添加到 UMDF 1,并且对较新版本的 Windows 10 上的 UMDF 1 的支持有限。 通用 Windows 驱动程序必须使用 UMDF 2。 有关详细信息,请参阅 UMDF入门 。]

RetrievePipePolicy 方法检索 WinUsb 管道策略。

语法

HRESULT RetrievePipePolicy(
  [in]      ULONG PolicyType,
  [in, out] ULONG *ValueLength,
  [out]     PVOID Value
);

参数

[in] PolicyType

UMDF 驱动程序请求的 WinUsb 管道策略的类型。

[in, out] ValueLength

指向一个变量的指针,该变量包含 RetrievePipePolicyValue提供的缓冲区的大小(以字节为单位)。 输出时,此参数包含 RetrievePipePolicyValue所需的大小。

[out] Value

一个指针,用于接收包含 WinUsb 管道策略的缓冲区。

返回值

RetrievePipePolicy 返回以下值之一:

返回代码 描述
S_OK

RetrievePipePolicy 已成功检索 WinUsb 管道策略。

E_OUTOFMEMORY

RetrievePipePolicy 遇到分配失败。

Winerror.h 中定义的错误代码
此值对应于 WinUsb API 返回的错误代码。

言论

管道策略控制 USB 管道的行为(例如超时、处理短数据包等)。

有关 UMDF 驱动程序可为 PolicyType 传递的有效策略类型的详细信息, 参数和框架返回的值,请参阅 WinUsb_GetPipePolicy 函数。

有关管道策略的行为的信息,请参阅 用于管道策略修改的 WinUSB 函数

RetrievePipePolicy 方法生成 UMDF 请求,并将请求同步发送到 I/O 目标。

要求

要求 价值
终止支持 在 UMDF 2.0 及更高版本中不可用。
目标平台 桌面
最低 UMDF 版本 1.5
标头 wudfusb.h (包括 Wudfusb.h)
DLL WUDFx.dll

另请参阅

IWDFUsbTargetPipe

IWDFUsbTargetPipe::SetPipePolicy

WinUsb_GetPipePolicy