IXpsOMDocumentSequence::GetDocuments method

Gets a pointer to the IXpsOMDocumentCollection interface, which contains the documents specified in the document sequence.

Syntax


HRESULT GetDocuments(
  [out, retval] IXpsOMDocumentCollection **documents
);

Parameters

documents [out, retval]

A pointer to the IXpsOMDocumentCollection interface, which contains the documents specified in the document sequence. If the sequence does not have any documents, the IXpsOMDocumentCollection interface will be empty.

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 codeDescription
S_OK

The method succeeded.

E_POINTER

documents is NULL.

 

Remarks

If the document sequence does not have any documents, the document collection that is returned in documents will be empty. To get the number of documents in the collection, call the collection's GetCount method.

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

IXpsOMDocumentSequence
XPS Document Errors
XML Paper Specification

 

 

Show: