Partager via


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

Récupère le nom convivial du composant, qui est un nom d’affichage lisible par l’utilisateur pour le composant.

Syntaxe

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

Paramètres

[in] cchFriendlyName

Type : UINT

Taille de la mémoire tampon wzFriendlyName .

[in, out] wzFriendlyName

Type : WCHAR*

Pointeur qui reçoit le nom convivial du composant. Les paramètres régionaux de la chaîne dépendent de la valeur que le codec a écrite dans le Registre au moment de l’installation. Pour les composants intégrés, ces chaînes sont toujours en anglais.

[out] pcchActual

Type : UINT*

Pointeur qui reçoit la longueur réelle du nom convivial du composant.

Valeur retournée

Type : HRESULT

Si cette méthode réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Si cchFriendlyName est 0 et wzFriendlyName a la valeur NULL, la taille de mémoire tampon requise est retournée dans pccchActual.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows XP avec SP2, Windows Vista [applications de bureau | Applications UWP]
Serveur minimal pris en charge Windows Server 2008 [applications de bureau | applications UWP]
Plateforme cible Windows
En-tête wincodec.h
Bibliothèque Windowscodecs.lib
DLL Windowscodecs.dll