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


Метод IWICComponentInfo::GetFriendlyName (wincodec.h)

Извлекает понятное имя компонента, которое является удобочитаемым отображаемым именем компонента.

Синтаксис

HRESULT GetFriendlyName(
  [in]      UINT  cchFriendlyName,
  [in, out] WCHAR *wzFriendlyName,
  [out]     UINT  *pcchActual
);

Параметры

[in] cchFriendlyName

Тип: UINT

Размер буфера wzFriendlyName .

[in, out] wzFriendlyName

Тип: WCHAR*

Указатель, получающий понятное имя компонента. Языковой стандарт строки зависит от значения, которое кодек записал в реестр во время установки. Для встроенных компонентов эти строки всегда на английском языке.

[out] pcchActual

Тип: UINT*

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

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

Тип: HRESULT

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

Комментарии

Если cchFriendlyName имеет значение 0, а wzFriendlyName равно NULL, требуемый размер буфера возвращается в pccchActual.

Требования

Требование Значение
Минимальная версия клиента Windows XP с пакетом обновления 2 (SP2), Windows Vista [классические приложения | Приложения UWP]
Минимальная версия сервера Windows Server 2008 [классические приложения | Приложения UWP]
Целевая платформа Windows
Header wincodec.h
Библиотека Windowscodecs.lib
DLL Windowscodecs.dll