IXpsOMObjectFactory::CreateDocumentStructureResource method (xpsobjectmodel.h)

Article
10/13/2021

Creates an IXpsOMDocumentStructureResource interface, which provides access to the document structure resource stream.

Syntax

HRESULT CreateDocumentStructureResource(
  [in]          IStream                         *acquiredStream,
  [in]          IOpcPartUri                     *partUri,
  [out, retval] IXpsOMDocumentStructureResource **documentStructureResource
);

Parameters

[in] acquiredStream

The read-only IStream interface to be associated with this resource. This parameter must not be NULL.

Important Treat this stream as a Single-Threaded Apartment (STA) object; do not re-enter it.

[in] partUri

The IOpcPartUri interface that contains the part name to be assigned to this resource. This parameter must not be NULL.

[out, retval] documentStructureResource

A pointer to the new IXpsOMDocumentStructureResource 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	acquiredStream, partUri, or documentStructureResource is NULL.

Remarks

The DocumentStructure part of an XPS document contains the document outline, which, with the StoryFragments parts, defines the reading order of every element that appears in the fixed pages of the document. This interface enables a program to read the XML contents of the DocumentStructure part and also to replace the XML contents of the DocumentStructure part.

The DocumentStructure part contains the document framework and the outline that describes the overall reading order of the document. The reading order is organized into semantic blocks called stories. Stories are logical units of the document in the same way as articles are units in a magazine. Stories are made up of one or more StoryFragments parts.

The StoryFragments parts contain content structure markup that defines the story's semantic blocks, such as the paragraphs and tables that make up the story's content.

The content of the DocumentStructure and StoryFragments parts is described in the XML Paper Specification.

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