Skip to content

Latest commit

 

History

History
129 lines (99 loc) · 4.14 KB

nf-xpsobjectmodel-ixpsompackage-setthumbnailresource.md

File metadata and controls

129 lines (99 loc) · 4.14 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:xpsobjectmodel.IXpsOMPackage.SetThumbnailResource
IXpsOMPackage::SetThumbnailResource (xpsobjectmodel.h)
Sets the thumbnail image of the XPS document.
IXpsOMPackage interface [XPS Documents and Packaging]
SetThumbnailResource method
IXpsOMPackage.SetThumbnailResource
IXpsOMPackage::SetThumbnailResource
SetThumbnailResource
SetThumbnailResource method [XPS Documents and Packaging]
SetThumbnailResource method [XPS Documents and Packaging]
IXpsOMPackage interface
xps.ixpsompackage_setthumbnailresource
xpsobjectmodel/IXpsOMPackage::SetThumbnailResource
xps\ixpsompackage_setthumbnailresource.htm
xps
1d5d5332-f6e1-4fad-8b45-c518196c17d2
12/05/2018
IXpsOMPackage interface [XPS Documents and Packaging],SetThumbnailResource method, IXpsOMPackage.SetThumbnailResource, IXpsOMPackage::SetThumbnailResource, SetThumbnailResource, SetThumbnailResource method [XPS Documents and Packaging], SetThumbnailResource method [XPS Documents and Packaging],IXpsOMPackage interface, xps.ixpsompackage_setthumbnailresource, xpsobjectmodel/IXpsOMPackage::SetThumbnailResource
xpsobjectmodel.h
Windows
Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| UWP apps]
Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| UWP apps]
XpsObjectModel.idl
Windows
19H1
IXpsOMPackage::SetThumbnailResource
xpsobjectmodel/IXpsOMPackage::SetThumbnailResource
c++
APIRef
kbSyntax
COM
xpsobjectmodel.h
IXpsOMPackage.SetThumbnailResource

IXpsOMPackage::SetThumbnailResource

-description

Sets the thumbnail image of the XPS document.

-parameters

-param 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.

-returns

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.

-see-also

IXpsOMImageResource

IXpsOMPackage

XML Paper Specification

XPS Document Errors

XPS_IMAGE_TYPE