Edit

Share via

IWICBitmapDecoder::GetThumbnail method (wincodec.h)

  • Article

Retrieves a bitmap thumbnail of the image, if one exists

Syntax

HRESULT GetThumbnail(
  [out] IWICBitmapSource **ppIThumbnail
);

Parameters

[out] ppIThumbnail

Type: IWICBitmapSource**

Receives a pointer to the IWICBitmapSource of the thumbnail.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The returned thumbnail can be of any size, so the caller should scale the thumbnail to the desired size. The only Windows provided image formats that support thumbnails are JPEG, TIFF, and JPEG-XR. If the thumbnail is not available, this will return WINCODEC_ERR_CODECNOTHUMBNAIL.

Requirements

Requirement Value
Minimum supported client Windows XP with SP2, Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header wincodec.h
Library Windowscodecs.lib
DLL Windowscodecs.dll