Image::GetEncoderParameterListSize method (gdiplusheaders.h)

Article
02/22/2024

The Image::GetEncoderParameterListSize method gets the size, in bytes, of the parameter list for a specified image encoder.

Syntax

UINT GetEncoderParameterListSize(
  [in] const CLSID *clsidEncoder
);

Parameters

[in] clsidEncoder

Type: const CLSID*

Pointer to a CLSID that specifies the encoder.

Return value

Type: UINT

This method returns the size, in bytes, of the parameter list.

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