IXpsOMObjectFactory::CreatePage method (xpsobjectmodel.h)

Article
02/22/2024

Creates an IXpsOMPage interface, which provides the root node of a tree of objects that represent the contents of a single page.

Syntax

HRESULT CreatePage(
  [in]          const XPS_SIZE *pageDimensions,
  [in]          LPCWSTR        language,
  [in]          IOpcPartUri    *partUri,
  [out, retval] IXpsOMPage     **page
);

Parameters

[in] pageDimensions

The XPS_SIZE structure that specifies the size of the page to be created.

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.

[in] language

The string that indicates the default language of the created page.

Important The language string must follow the RFC 3066 syntax.

[in] partUri

The IOpcPartUri interface that contains the part name to be assigned to this resource.

[out, retval] page

A pointer to the new IXpsOMPage 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	pageDimensions, partUri, or page is NULL.
XPS_E_INVALID_LANGUAGE	language does not contain a valid language string.
XPS_E_INVALID_PAGE_SIZE	pageDimensions contains an invalid page size or invalid page size values.

Remarks

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


IXpsOMPage        *newInterface;
// The following values are defined outside of 
// this example.
//  LPWSTR        language;
//  XPS_SIZE      pageDimensions;

// 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->CreatePartUri(partUriString, &partUri);
    if (SUCCEEDED(hr))
    {
        hr = xpsFactory->CreatePage (
            &pageDimensions,
            language,
            partUri,
            &newInterface);

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

            newInterface->Release();
        }
        partUri->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