IWICComponentInfo::GetAuthor method (wincodec.h)

Article
02/22/2024

Retrieves the name of component's author.

Syntax

HRESULT GetAuthor(
  [in]      UINT  cchAuthor,
  [in, out] WCHAR *wzAuthor,
  [out]     UINT  *pcchActual
);

Parameters

[in] cchAuthor

Type: UINT

The size of the wzAuthor buffer.

[in, out] wzAuthor

Type: WCHAR*

A pointer that receives the name of the component's author. 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 authors name. The author name is optional; if an author name is not specified by the component, the length returned is 0.

Return value

Type: HRESULT

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

Remarks

If cchAuthor is 0 and wzAuthor 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