Share via


IImageEncoder::GetEncoderParameterList (Windows CE 5.0)

Send Feedback

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

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 Values

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.

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

Params[1] = {
  ENCODER_SAVE_FLAG,
  1,
  EncoderParameterValueTypeLong,
  { // Value
    EncoderValueMultiFrame
  }
}

Requirements

OS Versions: Windows CE 5.0 and later.
Header: Imaging.h.
Link Library: Imaging.lib.

See Also

IImageEncoder | IImageEncoder::GetEncoderParameterListSize | EncoderParameters

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.