Поделиться через


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

[ предупреждение: 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 NULL, в строке, на которую буфер указывает.

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

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

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

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

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

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

Требования

Требование Ценность
завершение поддержки Недоступно в UMDF 2.0 и более поздних версиях.
целевая платформа Настольный
минимальная версия UMDF 1.5
заголовка wudfddi.h (include Wudfddi.h)
DLL WUDFx.dll

См. также

IWDFDeviceInitialize