Edit

Share via

IWICBitmapDecoder::GetPreview method (wincodec.h)

  • Article

Retrieves a preview image, if supported.

Syntax

HRESULT GetPreview(
  [out] IWICBitmapSource **ppIBitmapSource
);

Parameters

[out] ppIBitmapSource

Type: IWICBitmapSource**

Receives a pointer to the preview bitmap if supported.

Return value

Type: HRESULT

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

Remarks

Not all formats support previews. Only the native Microsoft Windows Digital Photo (WDP) codec support previews.

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