IWICComponentInfo::GetFriendlyName method (wincodec.h)

Article
10/13/2021

Retrieves the component's friendly name, which is a human-readable display name for the component.

Syntax

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

Parameters

[in] cchFriendlyName

Type: UINT

The size of the wzFriendlyName buffer.

[in, out] wzFriendlyName

Type: WCHAR*

A pointer that receives the friendly name of the component. The locale of the string depends on the value that the codec wrote to the registry at install time. For built-in components, these strings are always in English.

[out] pcchActual

Type: UINT*

A pointer that receives the actual length of the component's friendly name.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

If cchFriendlyName is 0 and wzFriendlyName is NULL, the required buffer size is returned in pccchActual.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2, Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 [desktop apps \| UWP apps]
Target Platform	Windows
Header	wincodec.h
Library	Windowscodecs.lib
DLL	Windowscodecs.dll

Share via