IXpsOMPage::GetPageDimensions method (xpsobjectmodel.h)

Gets the page dimensions.

Syntax

HRESULT GetPageDimensions(
  [out, retval] XPS_SIZE *pageDimensions
);

Parameters

[out, retval] pageDimensions

The page dimensions.

Size is described in XPS units. There are 96 XPS units per inch. For example, the dimensions of an 8.5" by 11.0" page are 816 by 1,056 XPS units.

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

Remarks

The default page size is passed to IXpsOMObjectFactory::CreatePage in the pageDimensions parameter.

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

IXpsOMPage

XML Paper Specification

XPS Document Errors

XPS_SIZE