Функция GetThemeDocumentationProperty (uxtheme.h)

  • Статья

Извлекает значение свойства темы из раздела документации указанного файла темы.

Синтаксис

HRESULT GetThemeDocumentationProperty(
  [in]  LPCWSTR pszThemeName,
  [in]  LPCWSTR pszPropertyName,
  [out] LPWSTR  pszValueBuff,
  [in]  int     cchMaxValChars
);

Параметры

[in] pszThemeName

Тип: LPCWSTR

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

[in] pszPropertyName

Тип: LPCWSTR

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

Значение Значение
SZ_THDOCPROP_DISPLAYNAME
 Извлекает отображаемое имя темы.
SZ_THDOCPROP_TOOLTIP
 Извлекает подсказку, связанную с этой темой.
SZ_THDOCPROP_AUTHOR
 Извлекает имя автора темы.
SZ_THDOCPROP_CANONICALNAME
 Извлекает имя темы.

[out] pszValueBuff

Тип: LPWSTR

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

[in] cchMaxValChars

Тип: int

Значение типа int , указывающее максимальное количество символов, которое может содержать pszValueBuff .

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

Тип: HRESULT

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

Комментарии

Если свойство theme локализовано в строковой таблице файлов тем, эта функция возвращает локализованную версию.

Требования

Требование Значение
Минимальная версия клиента Windows Vista [только классические приложения]
Минимальная версия сервера Windows Server 2003 [только классические приложения]
Целевая платформа Windows
Header uxtheme.h
Библиотека UxTheme.lib
DLL UxTheme.dll