Método IWICComponentInfo::GetFriendlyName (wincodec.h)

Recupera el nombre descriptivo del componente, que es un nombre para mostrar legible para el componente.

Sintaxis

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

Parámetros

[in] cchFriendlyName

Tipo: UINT

Tamaño del búfer wzFriendlyName .

[in, out] wzFriendlyName

Tipo: WCHAR*

Puntero que recibe el nombre descriptivo del componente. La configuración regional de la cadena depende del valor que el códec escribió en el registro en tiempo de instalación. Para los componentes integrados, estas cadenas siempre están en inglés.

[out] pcchActual

Tipo: UINT*

Puntero que recibe la longitud real del nombre descriptivo del componente.

Valor devuelto

Tipo: HRESULT

Si este método se realiza correctamente, devuelve S_OK. De lo contrario, devuelve un código de error de HRESULT.

Comentarios

Si cchFriendlyName es 0 y wzFriendlyName es NULL, el tamaño de búfer necesario se devuelve en pccchActual.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP con SP2, Windows Vista [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible	Windows Server 2008 [aplicaciones de escritorio | aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	wincodec.h
Library	Windowscodecs.lib
Archivo DLL	Windowscodecs.dll