Метод IWDFDeviceInitialize::RetrieveDeviceInstanceId (wudfddi.h)

Статья
08/08/2023

[Предупреждение: UMDF 2 является последней версией UMDF и заменяет UMDF 1. Все новые драйверы UMDF должны быть написаны с помощью UMDF 2. Новые функции не добавляются в UMDF 1, а поддержка UMDF 1 в более новых версиях Windows 10 ограничена. Универсальные драйверы Windows должны использовать UMDF 2. Дополнительные сведения см. в разделе начало работы с помощью UMDF.]

Метод RetrieveDeviceInstanceId извлекает идентификатор экземпляра устройства.

Синтаксис

HRESULT RetrieveDeviceInstanceId(
  [out, optional] PWSTR Buffer,
  [in, out]       DWORD *pdwSizeInChars
);

Параметры

[out, optional] Buffer

Указатель на буфер, который получает строку, завершающуюся значением NULL, которая представляет идентификатор экземпляра устройства, если предоставленный буфер не равен NULL , и значение RetrieveDeviceInstanceId выполнено успешно.

[in, out] pdwSizeInChars

Указатель на переменную, которая получает количество символов, включая символ NULL , в строке, на которую указывает Buffer .

Если buffer имеет значение NULL, то драйвер предоставляет нулевое значение. Затем платформа возвращает размер в символах, необходимый для строки идентификатора.

Если значение Buffer не равно NULL, платформа возвращает размер строки идентификатора в символах.

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

RetrieveDeviceInstanceId возвращает S_OK для следующих сценариев:

Буфер, на который указал параметр Buffer , не имеет значения NULL и достаточно велик для хранения строки идентификатора, включая символ NULL , а платформа успешно скопирует строку в предоставленный буфер и задает для переменной, на которую указывает параметр pdwSizeInChars , количество символов в строке.
Буфер в buffer был равен NULL, драйвер предустановил переменную в pdwSizeInChars значение 0, а платформа задает переменной в pdwSizeInChars число символов, необходимых для строки.

RetrieveDeviceInstanceId возвращает HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER), чтобы указать, что предоставленный буфер не имеет значения NULL и не содержит достаточно места для хранения строки идентификатора. Платформа задает переменной в pdwSizeInChars количество символов, необходимых для строки.

RetrieveDeviceInstanceId может также возвращать другие значения HRESULT.

Требования

Требование	Значение
Дата окончания поддержки	Недоступно в UMDF 2.0 и более поздних версиях.
Целевая платформа	Персональный компьютер
Минимальная версия UMDF	1.5
Верхняя часть	wudfddi.h (включая Wudfddi.h)
DLL	WUDFx.dll

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

IWDFDeviceInitialize