Метод IWDFDriver::RetrieveVersionString (wudfddi.h)

Статья
08/08/2023

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

Метод RetrieveVersionString извлекает версию платформы.

Синтаксис

HRESULT RetrieveVersionString(
  [out]     PWSTR pVersion,
  [in, out] DWORD *pdwVersionLength
);

Параметры

[out] pVersion

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

[in, out] pdwVersionLength

Указатель на переменную, которая получает размер (в символах) строки версии, на которую указывает pVersion . На входных данных эта переменная содержит размер буфера в байтах в pVersion.

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

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

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

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

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

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

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

Требования

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