IImageDecoder::GetThumbnail

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method asks the decoder for a thumbnail of the current image. If the image does not contain thumbnail data, the decoder returns an error code.

Syntax

HRESULT GetThumbnail(
  OPTIONAL UINT thumbWidth,
  OPTIONAL UINT thumbHeight,
  IImage**      thumbImage
);

Parameters

• thumbWidth
  [in] An optional UINT value specifying the horizontal size, in pixels, of the thumbnail image. For more information, see the Remarks section.

• thumbHeight
  [in] An optional UINT value specifying the vertical size, in pixels, of the thumbnail image. For more information, see the Remarks section.

• thumbImage
  [out] A pointer to the resulting IImage interface pointer for the thumbnail image.

Return Value

If successful, this method returns S_OK.

This method may return E_NOTIMPL if it fails.

Remarks

The decoder is not required to return a thumbnail image with the exact dimensions specified by thumbWidth and thumbHeight. These values are used only as hints.

If thumbWidth and thumbHeight are set to 0, the decoder determines the thumbnail size.

Requirements

See Also

Reference

IImageDecoder