Skip to content

Latest commit

 

History

History
137 lines (98 loc) · 5.9 KB

nf-xpsobjectmodel-ixpsomobjectfactory-createdocumentstructureresource.md

File metadata and controls

137 lines (98 loc) · 5.9 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:xpsobjectmodel.IXpsOMObjectFactory.CreateDocumentStructureResource
IXpsOMObjectFactory::CreateDocumentStructureResource (xpsobjectmodel.h)
Creates an IXpsOMDocumentStructureResource interface, which provides access to the document structure resource stream.
CreateDocumentStructureResource
CreateDocumentStructureResource method [XPS Documents and Packaging]
CreateDocumentStructureResource method [XPS Documents and Packaging]
IXpsOMObjectFactory interface
IXpsOMObjectFactory interface [XPS Documents and Packaging]
CreateDocumentStructureResource method
IXpsOMObjectFactory.CreateDocumentStructureResource
IXpsOMObjectFactory::CreateDocumentStructureResource
xps.ixpsomobjectfactory_createdocumentstructureresource
xpsobjectmodel/IXpsOMObjectFactory::CreateDocumentStructureResource
xps\ixpsomobjectfactory_createdocumentstructureresource.htm
xps
ce41c5fb-033d-4140-b7aa-4f28676f0ae6
12/05/2018
CreateDocumentStructureResource, CreateDocumentStructureResource method [XPS Documents and Packaging], CreateDocumentStructureResource method [XPS Documents and Packaging],IXpsOMObjectFactory interface, IXpsOMObjectFactory interface [XPS Documents and Packaging],CreateDocumentStructureResource method, IXpsOMObjectFactory.CreateDocumentStructureResource, IXpsOMObjectFactory::CreateDocumentStructureResource, xps.ixpsomobjectfactory_createdocumentstructureresource, xpsobjectmodel/IXpsOMObjectFactory::CreateDocumentStructureResource
xpsobjectmodel.h
Windows
Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| UWP apps]
Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| UWP apps]
XpsObjectModel.idl
Windows
19H1
IXpsOMObjectFactory::CreateDocumentStructureResource
xpsobjectmodel/IXpsOMObjectFactory::CreateDocumentStructureResource
c++
APIRef
kbSyntax
COM
xpsobjectmodel.h
IXpsOMObjectFactory.CreateDocumentStructureResource

IXpsOMObjectFactory::CreateDocumentStructureResource

-description

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

-parameters

-param acquiredStream [in]

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.
 

-param partUri [in]

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

-param documentStructureResource [out, retval]

A pointer to the new IXpsOMDocumentStructureResource interface.

-returns

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.

-see-also

IOpcPartUri

IXpsOMDocumentStructureResource

IXpsOMObjectFactory

IXpsOMStoryFragmentsResource

XML Paper Specification

XPS Document Errors