Windows Dev Center

Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IWICBitmapDecoderInfo::GetPatterns method

Retrieves the file pattern signatures supported by the decoder.

Syntax


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

Parameters

cbSizePatterns [in]

Type: UINT

The array size of the pPatterns array.

pPatterns [out]

Type: WICBitmapPattern*

Receives a list of WICBitmapPattern objects supported by the decoder.

pcPatterns [out]

Type: UINT*

Receives the number of patterns the decoder supports.

pcbPatternsActual [out]

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

Minimum supported client

Windows XP with SP2, Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 [desktop apps | Windows Store apps]

Header

Wincodec.h

IDL

Wincodec.idl

Library

Windowscodecs.lib

DLL

Windowscodecs.dll

 

 

Community Additions

Show:
© 2015 Microsoft