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 且 wzFriendlyNameNULL,则将在 pccchActual 中返回所需的缓冲区大小。

要求

要求
最低受支持的客户端 Windows XP SP2、Windows Vista [桌面应用 |UWP 应用]
最低受支持的服务器 Windows Server 2008 [桌面应用 | UWP 应用]
目标平台 Windows
标头 wincodec.h
Library Windowscodecs.lib
DLL Windowscodecs.dll