WdfDeviceRetrieveDeviceName 函数 (wdfdevice.h)

  • 项目

[仅适用于 KMDF]

WdfDeviceRetrieveDeviceName 方法返回指定设备的设备名称。

语法

NTSTATUS WdfDeviceRetrieveDeviceName(
  [in] WDFDEVICE Device,
  [in] WDFSTRING String
);

参数

[in] Device

框架设备对象的句柄。

[in] String

接收设备名称的框架字符串对象的句柄。

返回值

如果操作成功， WdfDeviceRetrieveDeviceName 将返回STATUS_SUCCESS。 其他返回值包括：

返回代码 说明
STATUS_INVALID_PARAMETER
 检测到参数无效。
 

该方法可能会返回其他 NTSTATUS 值。

如果驱动程序提供无效的对象句柄，则会发生 bug 检查。

注解

WdfDeviceRetrieveDeviceName 方法返回驱动程序在上一次调用 WdfDeviceInitAssignName 中指定的设备名称。

若要从字符串对象获取设备名称字符串，驱动程序可以调用 WdfStringGetUnicodeString。

示例

下面的代码示例创建一个字符串对象，然后检索指定设备的名称。

NTSTATUS status;
WDFSTRING string;

status = WdfStringCreate(
                         NULL,
                         WDF_NO_OBJECT_ATTRIBUTES,
                         &string
                         );
if (NT_SUCCESS(status)) {
    status = WdfDeviceRetrieveDeviceName(
                                         Device,
                                         string
                                         );
    if (!NT_SUCCESS(status)) {
        return status;
    }
}

要求

要求 值
目标平台 通用
最低 KMDF 版本 1.0
标头 wdfdevice.h (包括 Wdf.h)
Library Wdf01000.sys (请参阅框架库 Versioning.)
IRQL PASSIVE_LEVEL
DDI 符合性规则 DriverCreate (kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、 KmdfIrqlExplicit (kmdf)

另请参阅

WdfDeviceInitAssignName

WdfDeviceQueryProperty

WdfStringCreate