Edit

IXpsOMPackage::GetDocumentSequence method (xpsobjectmodel.h)

  • Article

Gets a pointer to the IXpsOMDocumentSequence interface that contains the document sequence of the XPS package.

Syntax

HRESULT GetDocumentSequence(
  [out, retval] IXpsOMDocumentSequence **documentSequence
);

Parameters

[out, retval] documentSequence

A pointer to the IXpsOMDocumentSequence interface that contains the document sequence of the XPS package. If an IXpsOMDocumentSequence interface has not been set, 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
 documentSequence is NULL.

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

See also

IXpsOMDocumentSequence

IXpsOMPackage

XML Paper Specification

XPS Document Errors