The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IWICImageEncoder::WriteFrameThumbnail method

Encodes the image as a thumbnail to the frame given by the IWICBitmapFrameEncode.

Syntax

C++


HRESULT WriteFrameThumbnail(
  [in]               ID2D1Image            *pImage,
  [in]               IWICBitmapFrameEncode *pFrameEncode,
  [in, unique] const WICImageParameters    *pImageParameters
);

Parameters

pImage [in]

Type: ID2D1Image*

The Direct2D image that will be encoded.

pFrameEncode [in]

Type: IWICBitmapFrameEncode*

The frame encoder on which the thumbnail is set.

pImageParameters [in]

Type: const WICImageParameters*

Additional parameters to control encoding.

Return value

Type: HRESULT

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

Remarks

The image passed in must be created on the same device as in IWICImagingFactory2::CreateImageEncoder. If the pImageParameters are not specified, a set of useful defaults will be assumed, see WICImageParameters for more info.

You must correctly and independently have set up the IWICBitmapFrameEncode before calling this API.

Requirements

Minimum supported client	Windows 8 [desktop apps \| Windows Store apps]
Minimum supported server	Windows Server 2012 [desktop apps \| Windows Store apps]
Header	Wincodec.h
IDL	Wincodec.idl
Library	Windowscodecs.lib
DLL	Windowscodecs.dll