IXpsOMPageReference::GetStoryFragmentsResource method

Gets a pointer to the IXpsOMStoryFragmentsResource interface of the StoryFragments part resource that is associated with the page.

Syntax

HRESULT GetStoryFragmentsResource(
  [out, retval] IXpsOMStoryFragmentsResource **storyFragmentsResource
);

Parameters

  • storyFragmentsResource [out, retval]
    A pointer to the IXpsOMStoryFragmentsResource interface of the StoryFragments part resource that is associated with the page. If there is no StoryFragments part, a NULL pointer is returned.

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

storyFragmentsResource is NULL.

 

This method calls the Packaging API. For information about the Packaging API return values, see Packaging Errors.

Remarks

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

The StoryFragments part of a page contains the XML markup that describes the portions of one or more stories that are associated with a single fixed page. Some of the document contents that might be described by the XML markup in a StoryFragments part include the story's tables and paragraphs that are found on the page.

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

Requirements

Minimum supported client

Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | Windows Store apps]

Header

Xpsobjectmodel.h

IDL

XpsObjectModel.idl

See also

IXpsOMPageReference

IXpsOMDocumentStructureResource

IXpsOMStoryFragmentsResource

Packaging Errors

XPS Document Errors

XML Paper Specification