IWICBitmapDecoderInfo::GetPatterns method (wincodec.h)

Article
10/13/2021

Retrieves the file pattern signatures supported by the decoder.

Syntax

HRESULT GetPatterns(
  [in]  UINT             cbSizePatterns,
  [out] WICBitmapPattern *pPatterns,
  [out] UINT             *pcPatterns,
  [out] UINT             *pcbPatternsActual
);

Parameters

[in] cbSizePatterns

Type: UINT

The array size of the pPatterns array.

[out] pPatterns

Type: WICBitmapPattern*

Receives a list of WICBitmapPattern objects supported by the decoder.

[out] pcPatterns

Type: UINT*

Receives the number of patterns the decoder supports.

[out] pcbPatternsActual

Type: UINT*

Receives the actual buffer size needed to retrieve all pattern signatures supported by the decoder.

Return value

Type: HRESULT

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

Remarks

To retrieve all pattern signatures, this method should first be called with pPatterns set to NULL to retrieve the actual buffer size needed through pcbPatternsActual. Once the needed buffer size is known, allocate a buffer of the needed size and call GetPatterns again with the allocated buffer.

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