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


Метод IPropertyDescription::GetCanonicalName (propsys.h)

Возвращает имя с учетом регистра, по которому свойство известно системе, независимо от его локализованного имени.

Синтаксис

HRESULT GetCanonicalName(
  [out] LPWSTR *ppszName
);

Параметры

[out] ppszName

Тип: LPWSTR*

При возврате этим методом содержит адрес указателя на каноническое имя свойства в виде строки Юникода, заканчивающейся null.

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

Тип: HRESULT

Если этот метод завершается успешно, он возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

Комментарии

Сведения, полученные этим методом, поступают из атрибута name элемента propertyDescription в PROPDESC-файле свойства.

Вызывающее приложение обязано использовать CoTaskMemFree , чтобы освободить строку, на которую ссылается ppszName , когда она больше не нужна.

Требования

Требование Значение
Минимальная версия клиента Windows Vista [только классические приложения]
Минимальная версия сервера Windows Server 2008 [только классические приложения]
Целевая платформа Windows
Header propsys.h

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

IPropertyDescription

Схема описания свойства