Edit

Share via

IShellImageData::GetEncoderParams method (shimgdata.h)

  • Article

Gets the current set of encoder parameters.

Syntax

HRESULT GetEncoderParams(
  [in]  GUID              *pguidFmt,
  [out] EncoderParameters **ppEncParams
);

Parameters

[in] pguidFmt

Type: GUID*

A pointer to a GUID that specifies the encoder. This must be an encoder supported by GDI+. If this parameter is NULL, an unhandled exception results.

[out] ppEncParams

Type: EncoderParameters**

The address of a pointer to an array of EncoderParameter objects.

Return value

Type: HRESULT

Returns S_OK if successful or an error value otherwise, including the following:

Return code Description
E_FAIL
 Several circumstances can generate this return value.
  • The image was not decoded or the decoding process failed.
  • pguidFmt refers to a format not supported by GDI+.
  • An internal call failed.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header shimgdata.h
DLL Shell32.dll