Export (0) Print
Expand All

IWICBitmapFrameDecode::GetThumbnail method

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

Syntax


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

Parameters

ppIThumbnail [out]

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

Minimum supported client

Windows XP with SP2, Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 [desktop apps | Windows Store apps]

Header

Wincodec.h

IDL

Wincodec.idl

Library

Windowscodecs.lib

DLL

Windowscodecs.dll

 

 

Community Additions

ADD
Show:
© 2014 Microsoft