IXpsOMPageReference::GetThumbnailResource method
Gets a pointer to the IXpsOMImageResource interface of the thumbnail image resource that is associated with the page.
Syntax
HRESULT GetThumbnailResource(
[out, retval] IXpsOMImageResource **imageResource
);
Parameters
- imageResource [out, retval]
A pointer to the IXpsOMImageResource interface of the thumbnail image resource that is associated with the page. If no thumbnail image resource has been assigned to the page, a NULL pointer is returned.
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 | imageResource is NULL. |
This method calls the Packaging API. For information about the Packaging API return values, see Packaging Errors.
Remarks
The thumbnail image is a small, visual representation of the page's contents.
After loading and parsing the resource into the XPS OM, this method might return an error that applies to another resource. This occurs because all of the relationships are parsed when a resource is loaded.
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 |