IXpsOMPart::SetPartName method (xpsobjectmodel.h)

Article
02/22/2024

Sets the name that will be used when the part is serialized.

Syntax

HRESULT SetPartName(
  [in] IOpcPartUri *partUri
);

Parameters

[in] partUri

A pointer to the IOpcPartUri interface that contains the name of this part. This parameter cannot be NULL.

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	partUri is NULL.

Remarks

IXpsOMPackageWriter will generate an error if it encounters an XPS document part whose name is the same as that of a part it has previously serialized.

Requirements

Requirement	Value
Minimum supported client	Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| UWP apps]
Target Platform	Windows
Header	xpsobjectmodel.h