Функция WdfDeviceRetrieveDeviceName (wdfdevice.h)

  • Статья

[Применяется только к KMDF]

Метод WdfDeviceRetrieveDeviceName возвращает имя устройства для указанного устройства.

Синтаксис

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

Параметры

[in] Device

Дескриптор объекта устройства платформы.

[in] String

Дескриптор для объекта строки платформы, получающего имя устройства.

Возвращаемое значение

Если операция выполнена успешно, WdfDeviceRetrieveDeviceName возвращает STATUS_SUCCESS. К дополнительным возвращаемым значениям относятся:

Код возврата Описание
STATUS_INVALID_PARAMETER
 Обнаружен недопустимый параметр.
 

Метод может возвращать другие значения NTSTATUS.

Ошибка проверка возникает, если драйвер предоставляет недопустимый дескриптор объекта.

Комментарии

Метод 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)
Библиотека Wdf01000.sys (см. раздел Управление версиями библиотеки платформы).
IRQL PASSIVE_LEVEL
Правила соответствия DDI DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

См. также раздел

WdfDeviceInitAssignName

WdfDeviceQueryProperty

WdfStringCreate