IXpsOMVisual::GetName method (xpsobjectmodel.h)

Gets the Name property of the visual.

Syntax

HRESULT GetName(
  [out, retval] LPWSTR *name
);

Parameters

[out, retval] name

The Name property string. If the Name property has not been set, 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
name is NULL.

Remarks

This method allocates the memory that is used by the string returned in name. If name is not NULL, use the CoTaskMemFree function to free the memory.

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

See also

IXpsOMVisual

XML Paper Specification

XPS Document Errors