Share via


IXpsOMPageReference::GetAdvisoryPageDimensions method

Gets the suggested dimensions of the page.

Syntax

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

Parameters

  • pageDimensions [out, retval]
    The suggested dimensions of the page.

    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

If the method succeeds, it returns S_OK; otherwise, it returns an HRESULT error code.

Return code Description
S_OK

The method succeeded.

E_POINTER

pageDimensions is NULL.

 

Remarks

Note   If a dimension value has not been set, a value of –1.0 is returned for that dimension.

 

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

IXpsOMPageReference

XPS_SIZE

XML Paper Specification