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

Recupera o nome amigável do componente, que é um nome de exibição legível para o componente.

Sintaxe

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

Parâmetros

[in] cchFriendlyName

Tipo: UINT

O tamanho do buffer wzFriendlyName .

[in, out] wzFriendlyName

Tipo: WCHAR*

Um ponteiro que recebe o nome amigável do componente. A localidade da cadeia de caracteres depende do valor que o codec escreveu no registro no momento da instalação. Para componentes internos, essas cadeias de caracteres estão sempre em inglês.

[out] pcchActual

Tipo: UINT*

Um ponteiro que recebe o comprimento real do nome amigável do componente.

Retornar valor

Tipo: HRESULT

Se o método for bem-sucedido, ele retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

Se cchFriendlyName for 0 e wzFriendlyName for NULL, o tamanho do buffer necessário será retornado em pccchActual.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows XP com SP2, Windows Vista [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte	Windows Server 2008 [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino	Windows
Cabeçalho	wincodec.h
Biblioteca	Windowscodecs.lib
DLL	Windowscodecs.dll