IXpsOMDocument::GetDocumentStructureResource method (xpsobjectmodel.h)

Article
02/22/2024

Gets a pointer to the IXpsOMDocumentStructureResource interface of the resource that contains structural information about the document.

Syntax

HRESULT GetDocumentStructureResource(
  [out, retval] IXpsOMDocumentStructureResource **documentStructureResource
);

Parameters

[out, retval] documentStructureResource

A pointer to the IXpsOMDocumentStructureResource interface of the resource. A NULL pointer is returned if an IXpsOMDocumentStructureResource interface is not present or has not been specified.

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	documentStructureResource is NULL.

Remarks

After loading and parsing the resource into the XPS OM, this method might return an error that applies to another resource. This occurs because all of the relationships are parsed when a resource is loaded.

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