IXpsOMPageReference::SetThumbnailResource method
Sets the pointer to the IXpsOMImageResource interface of the thumbnail image resource to be assigned to the page.
Syntax
HRESULT SetThumbnailResource(
[in] IXpsOMImageResource *imageResource
);
Parameters
- imageResource [in]
A pointer to the IXpsOMImageResource interface of the thumbnail image resource to be assigned to the page. If an IXpsOMImageResource interface has been set, a NULL pointer will release it.
Return value
If the method succeeds, it returns S_OK; otherwise, it returns an HRESULT error code.
| 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 |