IImage::GetThumbnail

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method returns a thumbnail image for the current image object.

Optional thumbWidth and thumbHeight parameters specify the desired thumbnail size (in pixel units). If they are both 0, the thumbnail size is determined by the image object.

Syntax

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

Parameters

• thumbWidth
  [in] An optional UINT value specifying the desired horizontal size, measured in pixels, of the new thumbnail image.

• thumbHeight
  [in] An optional UINT value specifying the desired vertical size, measured in pixels, of the new thumbnail image.

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

Return Value

If successful, this method returns S_OK.

If it fails, this method should return one of the following error values:

• IMGERR_CODECNOTFOUND
• IMGERR_OBJECTBUSY
• E_INVALIDARG
• E_OUTOFMEMORY

For more information, see Error Codes for the Imaging API.

Remarks

If the image object contains thumbnail data, this method creates the thumbnail image from that data. Otherwise, this method generates a thumbnail image for itself.

Requirements

See Also

Reference

IImage