Image::GetEncoderParameterList method (gdiplusheaders.h)

Article
10/13/2021

The Image::GetEncoderParameterList method gets a list of the parameters supported by a specified image encoder.

Syntax

Status GetEncoderParameterList(
  [in]  const CLSID       *clsidEncoder,
  [in]  UINT              size,
  [out] EncoderParameters *buffer
);

Parameters

[in] clsidEncoder

Type: const CLSID*

Pointer to a CLSID that specifies the encoder.

[in] size

Type: UINT

Integer that specifies the size, in bytes, of the buffer array. Call the Image::GetEncoderParameterListSize method to obtain the required size.

[out] buffer

Type: EncoderParameters*

Pointer to an EncoderParameters object that receives the list of supported parameters.

Return value

Type: Status

If the method succeeds, it returns Ok, which is an element of the Status enumeration.

If the method fails, it returns one of the other elements of the Status enumeration.

Remarks

The Image::GetEncoderParameterList method returns an array of EncoderParameter objects. Before you call Image::GetEncoderParameterList, you must allocate a buffer large enough to receive that array, which is part of an EncoderParameters object. You can call the Image::GetEncoderParameterListSize method to get the size, in bytes, of the required EncoderParameters object.

Requirements

Requirement	Value
Minimum supported client	Windows XP, Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	gdiplusheaders.h (include Gdiplus.h)
Library	Gdiplus.lib
DLL	Gdiplus.dll