IWDFDriver::RetrieveVersionString 方法 (wudfddi.h)

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

RetrieveVersionString 方法检索框架的版本。

语法

HRESULT RetrieveVersionString(
  [out]     PWSTR pVersion,
  [in, out] DWORD *pdwVersionLength
);

参数

[out] pVersion

指向缓冲区的指针,该缓冲区接收以 NULL 结尾的字符串,如果提供的缓冲区为非 NULLRetrieveVersionString 成功,该字符串表示框架的版本。

[in, out] pdwVersionLength

指向变量的指针,该变量接收 pVersion 所指向的版本字符串的大小(以字符为单位)。 输入时,此变量包含 pVersion 缓冲区的大小(以字节为单位)。

如果 pVersion 处的缓冲区为 NULL,则驱动程序提供的值为零。 然后,框架返回版本字符串所需的大小(以字符为单位)。

如果 pVersion 处的缓冲区为非 NULL,框架将返回版本字符串的大小(以字符为单位)。

返回值

RetrieveVersionString 在以下情况下返回S_OK:

  • pVersion 参数指向的缓冲区非 NULL 且足够大,足以容纳版本字符串,包括 NULL 字符。 此外,框架还成功将字符串复制到提供的缓冲区,并将 pdwVersionLength 参数指向的变量设置为字符串中的字符数。
  • pVersion 的缓冲区为 NULL,驱动程序将 pdwVersionLength 处的变量预设为 0,框架将 pdwVersionLength 处的变量设置为字符串所需的字符数。
RetrieveVersionString 返回HRESULT_FROM_WIN32 (ERROR_INSUFFICIENT_BUFFER) ,指示提供的缓冲区为非 NULL ,并且不包含足够的空间来保存版本。 框架将 pdwVersionLength 中的变量设置为字符串所需的字符数。

RetrieveVersionString 也可能返回其他 HRESULT 值。

要求

要求
结束支持 在 UMDF 2.0 及更高版本中不可用。
目标平台 桌面
最低 UMDF 版本 1.5
标头 wudfddi.h (包括 Wudfddi.h)
DLL WUDFx.dll