IXpsOMPage::GetName method

Gets the Name property of the page.

Syntax


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

Parameters

name [out, retval]

The Name property of the page. A NULL pointer is returned if the Name property has not been set.

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 codeDescription
S_OK

The method succeeded.

E_POINTER

name is NULL.

 

Remarks

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

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

See also

IXpsOMPage
XPS Document Errors
XML Paper Specification

 

 

Show: