Метод IWDFNamedPropertyStore::GetNamedValue (wudfddi.h)

Статья
08/08/2023

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

Метод getNamedValue извлекает значение свойства.

Синтаксис

HRESULT GetNamedValue(
  [in]  LPCWSTR     pszName,
  [out] PROPVARIANT *pv
);

Параметры

[in] pszName

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

[out] pv

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

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

GetNamedValue возвращает S_OK, если операция выполнена успешно. В противном случае этот метод возвращает один из кодов ошибок, определенных в Winerror.h.

Замечания

Метод GetNamedValue выделяет память для строки в структуре PROPVARIANT , на которую указывает параметр pv. Вызывающий объект должен освободить эту память, вызвав функцию PropVariantClear, как показано в следующем фрагменте кода:

hr = pPropStore->GetNamedValue(L"Host", &val);
...
PropVariantClear(&val);

Если вызывающий объект не освобождает память, может возникнуть утечка памяти.

Для значений свойств поддерживаются следующие типы вариантов. В следующей таблице показан тип варианта, возвращаемый независимо от исходного типа варианта.

Тип variant	Извлекаемая тип variant
VT_BSTR	Хотя клиенты считывают строковое значение, значение возвращается как VT_LPWSTR независимо от исходного типа варианта, который использовался для записи значения.
VT_LPWSTR
VT_LPSTR
VT_I1	Хотя клиенты считывают целочисленное значение, значение возвращается как VT_UI4 независимо от исходного типа варианта, который использовался для записи значения.
VT_UI1
VT_I2
VT_UI2
VT_I4
VT_UI4
VT_UINT
VT_BLOB	Двоичное значение возвращается как VT_BLOB.
VT_VECTOR \| VT_LPWSTR	Массив строк возвращается как VT_VECTOR \| VT_LPWSTR

Строка, содержащая переменные среды, расширяется при чтении.

Дополнительные сведения см. в разделе Использование реестра в драйверах на основе UMDF.

Требования

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

См. также

IWDFNamedPropertyStore

PROPVARIANT

PropVariantClear

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