IXpsOMPackage::SetThumbnailResource method
Sets the thumbnail image of the XPS document.
Syntax
HRESULT SetThumbnailResource(
[in] IXpsOMImageResource *imageResource
);
Parameters
- imageResource [in]
The IXpsOMImageResource interface that contains the thumbnail image that will be assigned to the package. A NULL pointer releases any previously assigned thumbnail image resources.
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. |
| XPS_E_INVALID_THUMBNAIL_IMAGE_TYPE | The image in imageResource is not a supported image type. |
| XPS_E_NO_CUSTOM_OBJECTS | imageResource does not point to a recognized interface implementation. Custom implementation of XPS Document API interfaces is not supported. |
Remarks
The thumbnail image is a small, visual representation of the document's contents.
The image type of the image resource must be either XPS_IMAGE_TYPE_JPEG or XPS_IMAGE_TYPE_PNG.
Requirements
Minimum supported client |
Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | Windows Store apps] |
Minimum supported server |
Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | Windows Store apps] |
Header |
Xpsobjectmodel.h |
IDL |
XpsObjectModel.idl |