IWICComponentInfo::GetVersion method (wincodec.h)

Article
02/22/2024

Retrieves the component's version.

Syntax

HRESULT GetVersion(
  [in]      UINT  cchVersion,
  [in, out] WCHAR *wzVersion,
  [out]     UINT  *pcchActual
);

Parameters

[in] cchVersion

Type: UINT

The size of the wzVersion buffer.

[in, out] wzVersion

Type: WCHAR*

A pointer that receives a culture invariant string of the component's version.

[out] pcchActual

Type: UINT*

A pointer that receives the actual length of the component's version. The version is optional; if a value 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

All built-in components return "1.0.0.0", except for pixel formats, which do not have a version.

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