WdfDriverRetrieveVersionString 函数 (wdfdriver.h)

项目
08/08/2023

[适用于 KMDF 和 UMDF]

WdfDriverRetrieveVersionString 方法检索一个 Unicode 字符串，该字符串标识运行驱动程序时 Kernel-Mode 驱动程序框架的版本。

语法

NTSTATUS WdfDriverRetrieveVersionString(
  [in] WDFDRIVER Driver,
  [in] WDFSTRING String
);

参数

[in] Driver

驱动程序框架驱动程序对象的句柄，该驱动程序是从先前调用 WdfDriverCreate 或 WdfGetDriver 获取的。

[in] String

驱动程序从上一次调用 WdfStringCreate 获取的框架字符串对象的句柄。框架将版本字符串分配给字符串对象。

返回值

如果操作成功，WdfDriverRetrieveVersionString 将返回STATUS_SUCCESS。否则，此方法可能会返回以下值之一：

返回代码	说明
STATUS_INSUFFICIENT_RESOURCES	框架无法为 Unicode 字符串分配缓冲区。

此方法还可能返回其他 NTSTATUS 值。

如果驱动程序句柄无效，则会发生系统 bug 检查。

注解

如果想要显示标识框架库版本的字符串，驱动程序可以调用 WdfDriverRetrieveVersionString 。字符串的格式可能会从一个版本更改为另一个版本，因此驱动程序不得尝试解释字符串的格式或内容。

有关库版本的详细信息，请参阅框架库版本控制。

示例

下面的代码示例创建一个字符串对象，将版本字符串分配给对象，并在调试器正在运行时显示该字符串。

WDFSTRING string;
UNICODE_STRING us;

status = WdfStringCreate(
                         NULL,
                         WDF_NO_OBJECT_ATTRIBUTES,
                         &string
                         );
if (NT_SUCCESS(status)) {
    status = WdfDriverRetrieveVersionString(
                                            driver,
                                            string
                                            );
    if (NT_SUCCESS(status)) {
        WdfStringGetUnicodeString(
                                  string,
                                  &us
                                  );
        DbgPrint(
                 "WDF Version string:  %wZ\n",
                 &us
                 );
    }
    WdfObjectDelete(string);
}

要求

要求	值
目标平台	通用
最低 KMDF 版本	1.0
最低 UMDF 版本	2.0
标头	wdfdriver.h (包括 Wdf.h)
Library	Wdf01000.sys (KMDF) ;WUDFx02000.dll (UMDF)
IRQL	PASSIVE_LEVEL
DDI 符合性规则	DriverCreate (kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、 KmdfIrqlExplicit (kmdf)