IImageEncoder::GetEncoderParameterList (Compact 2013)

3/26/2014

This feature is being deprecated for this release. Refer to this component: Windows Imaging Component.

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::GetEncoderParameterListSize method.

• Params
  [out] A pointer to an array of EncoderParameters objects 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.

Code Example

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

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

Requirements

See Also

Reference

IImageEncoder
IImageEncoder::GetEncoderParameterListSize
EncoderParameters