IXpsOMObjectFactory::CreatePageReference method (xpsobjectmodel.h)

Article
02/22/2024

Creates an IXpsOMPageReference interface that enables the virtualization of pages.

Syntax

HRESULT CreatePageReference(
  [in]          const XPS_SIZE      *advisoryPageDimensions,
  [out, retval] IXpsOMPageReference **pageReference
);

Parameters

[in] advisoryPageDimensions

The XPS_SIZE structure that sets the advisory page dimensions (page width and page height).

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.

[out, retval] pageReference

A pointer to the new IXpsOMPageReference interface.

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	advisoryPageDimensions or pageReference is NULL.
XPS_E_INVALID_PAGE_SIZE	advisoryPageDimensions contains an invalid page size or invalid page size values.

Remarks

The use of a page reference makes it possible to delay the loading of the full object model of a page until the loading is requested explicitly. If the page has not been altered, it can be unloaded on request.

The code example that follows illustrates how this method is used to create a new interface.


IXpsOMPageReference    *newInterface;
// The following value is defined outside of 
// this example.
XPS_SIZE        advisoryPageDimensions;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

hr = CoCreateInstance(
    __uuidof(XpsOMObjectFactory),
    NULL,
    CLSCTX_INPROC_SERVER,
    _uuidof(IXpsOMObjectFactory),
    reinterpret_cast<LPVOID*>(&xpsFactory)
    );

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreatePageReference (
        &advisoryPageDimensions,
        &newInterface);

    if (SUCCEEDED(hr))
    {
        // use newInterface

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

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