Edit

IXpsOMObjectFactory1::CreatePageFromStream1 method (xpsobjectmodel_1.h)

  • Article

Reads the page markup from the specified stream to create and populate an IXpsOMPage1 interface.

Syntax

HRESULT CreatePageFromStream1(
  IStream             *pageMarkupStream,
  IOpcPartUri         *partUri,
  IXpsOMPartResources *resources,
  BOOL                reuseObjects,
  IXpsOMPage1         **page
);

Parameters

pageMarkupStream

[in] The stream that contains the page markup.

partUri

[in] The IOpcPartUri interface that contains the page's URI.

resources

[in] The IXpsOMPartResources interface that contains the resources used by the page.

reuseObjects

[in] A Boolean value that indicates that the software is to attempt to optimize the document object tree by sharing objects that are identical in all properties and children.

TRUE: The software will attempt to optimize the object tree.

FALSE: The software will not attempt to optimize the object tree.

page

[out, retval] A pointer to the new IXpsOMPage1 interface created by this method. -

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.

S_OK: The method succeeded.

XPS_E_INVALID_CONTENT_TYPE: The image resource type does not match the namespaces used in page markup. For example, one of the elements in the resources collection may be JpegXR but namespaces follow the MSXPS specification.

E_POINTER: pageMarkupStream, partUri, resources, or page is NULL.

XPS_E_NO_CUSTOM_OBJECTS: resource does not point to a recognized interface implementation. Custom implementation of XPS Document API interfaces is not supported.

Remarks

The IXpsOMPage1 interface returned by this method provides a GetDocumentType method that can be used to identify the XPS document type of the source XML markup in the stream. XPS document type determination is based on the XML namespaces that are used in source markup.

An IXpsOMPage1 interface that contains a document type of XPS_DOCUMENT_TYPE_ OPENXPS can be serialized as a document type of XPS_DOCUMENT_TYPE_ XPS if all of its image resources are compatible with the XPS_DOCUMENT_TYPE_ XPS document format.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 [desktop apps | UWP apps]
Target Platform Windows
Header xpsobjectmodel_1.h
Library None

See also

IXpsOMObjectFactory1