IXpsOMThumbnailGenerator::GenerateThumbnail method
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
page [in]
A pointer to the IXpsOMPage interface that contains the page for which the thumbnail image will be created.thumbnailType [in]
The XPS_IMAGE_TYPE value that specifies the type of thumbnail image to create.thumbnailSize [in]
The XPS_THUMBNAIL_SIZE value that specifies the image size of the thumbnail to create.imageResourcePartName [in]
A pointer to the IOpcPartUri interface that contains the name of the new thumbnail image part.imageResource [out, retval]
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
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] |
Header |
Xpsobjectmodel.h |
IDL |
XpsObjectModel.idl |