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.

Image.GetEncoderParameterList method

Applies to: desktop apps only

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

clsidEncoder [in]

Type: const CLSID*

Pointer to a CLSID that specifies the encoder.

size [in]

Type: UINT

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

buffer [out]

Type: EncoderParameters*

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

Return value

Type:

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

Minimum supported client

Windows XP, Windows 2000 Professional

Minimum supported server

Windows 2000 Server

Product

GDI+ 1.0

Header

Gdiplusheaders.h (include Gdiplus.h)

Library

Gdiplus.lib

DLL

Gdiplus.dll

See also

Image
Image::GetEncoderParameterListSize
GetImageEncoders
GetImageEncodersSize
Using Image Encoders and Decoders

 

 

Send comments about this topic to Microsoft

Build date: 3/6/2012

Show: