Edit

Share via

IXpsOMThumbnailGenerator::GenerateThumbnail method (xpsobjectmodel.h)

  • Article

Generates a thumbnail image of a page.

Syntax

HRESULT GenerateThumbnail(
  [in]          IXpsOMPage          *page,
  [in]          XPS_IMAGE_TYPE      thumbnailType,
  [in]          XPS_THUMBNAIL_SIZE  thumbnailSize,
  [in]          IOpcPartUri         *imageResourcePartName,
  [out, retval] IXpsOMImageResource **imageResource
);

Parameters

[in] page

A pointer to the IXpsOMPage interface that contains the page for which the thumbnail image will be created.

[in] thumbnailType

The XPS_IMAGE_TYPE value that specifies the type of thumbnail image to create.

[in] thumbnailSize

The XPS_THUMBNAIL_SIZE value that specifies the image size of the thumbnail to create.

[in] imageResourcePartName

A pointer to the IOpcPartUri interface that contains the name of the new thumbnail image part.

[out, retval] imageResource

A pointer to the new IXpsOMImageResource interface that contains the thumbnail image created by this method.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For information about XPS document API return values that are not listed in this table, see XPS Document Errors.

Return code Description
S_OK
 The method succeeded.
E_POINTER
 page, imageResourcePartName, or imageResource is NULL.
E_INVALIDARG
 One of the following parameters contains a value that is not valid:

Requirements

Requirement Value
Minimum supported client Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps only]
Target Platform Windows
Header xpsobjectmodel.h

See also

IOpcPartUri

IXpsOMImageResource

IXpsOMPage

IXpsOMThumbnailGenerator

XML Paper Specification

XPS Document Errors

XPS_IMAGE_TYPE

XPS_THUMBNAIL_SIZE