Metodo IWICComponentInfo::GetFriendlyName (wincodec.h)

Recupera il nome descrittivo del componente, ovvero un nome visualizzato leggibile per il componente.

Sintassi

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

Parametri

[in] cchFriendlyName

Tipo: UINT

Dimensione del buffer wzFriendlyName .

[in, out] wzFriendlyName

Tipo: WCHAR*

Puntatore che riceve il nome descrittivo del componente. Le impostazioni locali della stringa dipendono dal valore scritto dal codec nel Registro di sistema in fase di installazione. Per i componenti predefiniti, queste stringhe sono sempre in inglese.

[out] pcchActual

Tipo: UINT*

Puntatore che riceve la lunghezza effettiva del nome descrittivo del componente.

Valore restituito

Tipo: HRESULT

Se questo metodo ha esito positivo, restituisce S_OK. In caso contrario, restituisce un codice di errore HRESULT .

Commenti

Se cchFriendlyName è 0 e wzFriendlyName è NULL, la dimensione del buffer necessaria viene restituita in pccchActual.

Requisiti