Edit

IShellImageData::GetPixelFormat method (shimgdata.h)

  • Article

Gets the pixel format of the image.

Syntax

HRESULT GetPixelFormat(
  [out] PixelFormat *pFormat
);

Parameters

[out] pFormat

Type: PixelFormat*

A pointer to a value of type PixelFormat indicating the pixel format. This value is valid only when the method returns S_OK.

Return value

Type: HRESULT

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

Return code Description
E_FAIL
 The image has not been decoded or the decoding process failed.

Remarks

Values that identify various pixel formats are defined in Gdipluspixelformats.h.

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