IWICImagingFactory::CreateDecoder method (wincodec.h)

Article
02/22/2024

Creates a new instance of IWICBitmapDecoder.

Syntax

HRESULT CreateDecoder(
  [in]          REFGUID           guidContainerFormat,
  [in]          const GUID        *pguidVendor,
  [out, retval] IWICBitmapDecoder **ppIDecoder
);

Parameters

[in] guidContainerFormat

Type: REFGUID

The GUID for the desired container format.

Value	Meaning
GUID_ContainerFormatBmp	The BMP container format GUID.
GUID_ContainerFormatPng	The PNG container format GUID.
GUID_ContainerFormatIco	The ICO container format GUID.
GUID_ContainerFormatJpeg	The JPEG container format GUID.
GUID_ContainerFormatTiff	The TIFF container format GUID.
GUID_ContainerFormatGif	The GIF container format GUID.
GUID_ContainerFormatWmp	The HD Photo container format GUID.

[in] pguidVendor

Type: const GUID*

The GUID for the preferred encoder vendor.

Value	Meaning
NULL	No preferred codec vendor.
GUID_VendorMicrosoft	Prefer to use Microsoft encoder.
GUID_VendorMicrosoftBuiltIn	Prefer to use the native Microsoft encoder.

[out, retval] ppIDecoder

Type: IWICBitmapDecoder**

A pointer that receives a pointer to a new IWICBitmapDecoder. You must initialize this IWICBitmapDecoder on a stream using the Initialize method later.

Return value

Type: HRESULT

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

Remarks

Other values may be available for both guidContainerFormat and pguidVendor depending on the installed WIC-enabled encoders. The values listed are those that are natively supported by the operating system.

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