IXpsOMVisual::SetName method (xpsobjectmodel.h)

Article
02/22/2024

Sets the Name property of the visual.

Syntax

HRESULT SetName(
  [in] LPCWSTR name
);

Parameters

[in] name

The name of the visual. A NULL pointer clears the Name property.

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	According to the XML Paper Specification, the string that is passed in name is not a valid name.

Remarks

Names must be unique.

Clearing the Name property by passing a NULL pointer in name sets the IsHyperlinkTarget property to FALSE.

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