IShellImageData::GetEncoderParams method

Gets the current set of encoder parameters.

Syntax


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

Parameters

pguidFmt [in]

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.

ppEncParams [out]

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 codeDescription
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

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Shimgdata.h

IDL

Shimgdata.idl

DLL

Shell32.dll

 

 

Community Additions

ADD
Show:
© 2014 Microsoft