Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This method retrieves a list of all parameters supported by the image encoder.

Syntax 

HRESULT GetEncoderParameterList(
  UINT			
size,
  EncoderParameters* 
Params
);

Parameters

size

[in] A UINT value specifying the size, in bytes, of the parameter array in Params.

To obtain this value, call the IImageEncoder::GetEncoderParameterListSizemethod.

Params

[out] A pointer to an array of EncoderParametersobjects that the method populates with data for the individual parameters.

Return Value

If successful, this method returns S_OK.

This method may return E_NOTIMPL if it fails.

Remarks

The following code shows a parameter list returned by IImageEncoder::GetEncoderParameterList.

Copy Code 
Count = 2
Params[0] = {
  ENCODER_COMPRESSION, 
  3, 
  EncoderParameterValueTypeLong, 
  { // Value
	EncoderValueCompressionLZW,
	EncoderValueCompressionRle,
	EncoderValueCompressionNone
  }
}
Params[1] = {
  ENCODER_SAVE_FLAG,
  1,
  EncoderParameterValueTypeLong,
  { // Value
	EncoderValueMultiFrame
  }
}

Requirements

Header imaging.h
Library Imaging.lib
Windows Embedded CE Windows CE 5.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also