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