IWICBitmapFrameDecode::GetThumbnail method (wincodec.h)

Article
02/22/2024

Retrieves a small preview of the frame, if supported by the codec.

Syntax

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

Parameters

[out] ppIThumbnail

Type: IWICBitmapSource**

A pointer that 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

Not all formats support thumbnails. Joint Photographic Experts Group (JPEG), Tagged Image File Format (TIFF), and Microsoft Windows Digital Photo (WDP) support thumbnails.

Note to Implementers

If the codec does not support thumbnails, return WINCODEC_ERROR_CODECNOTHUMBNAIL rather than E_NOTIMPL.

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

Share via