Edit

Share via

IWICBitmapFrameEncode::Initialize method (wincodec.h)

  • Article

Initializes the frame encoder using the given properties.

Syntax

HRESULT Initialize(
  [in] IPropertyBag2 *pIEncoderOptions
);

Parameters

[in] pIEncoderOptions

Type: IPropertyBag2*

The set of properties to use for IWICBitmapFrameEncode initialization.

Return value

Type: HRESULT

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

Remarks

If you don't want any encoding options, pass NULL for pIEncoderOptions. Otherwise, pass the IPropertyBag2 that was provided by IWICBitmapEncoder::CreateNewFrame with updated values.

For a complete list of encoding options supported by the Windows-provided codecs, see Native WIC Codecs.

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