IXpsOMPage::SetName method
Sets the Name property of this page.
Syntax
HRESULT SetName(
[in] LPCWSTR name
);
Parameters
- name [in]
A pointer to the name string to be set as the page's Name property. A NULL pointer clears any previously assigned name.
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_NAME | The name string contains a character that is not valid. |
Remarks
The Name property identifies the current page as a named, addressable point in a document, allowing the page to be referenced by a hyperlink.
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 |