IXpsOMDocumentSequence interface

The root object that has the XPS document content.

When to implement

Never. Custom implementation of this interface is not supported.

Members

The IXpsOMDocumentSequence interface inherits from IXpsOMPart. IXpsOMDocumentSequence also has these types of members:

Methods

The IXpsOMDocumentSequence interface has these methods.

MethodDescription
GetDocuments

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

GetOwner

Gets a pointer to the IXpsOMPackage interface that contains the document sequence.

GetPrintTicketResource

Gets the IXpsOMPrintTicketResource interface to the job-level print ticket that is assigned to the document sequence.

SetPrintTicketResource

Sets the job-level print ticket resource for the document sequence.

 

Remarks

The code example that follows illustrates how to create an instance of this interface.



IXpsOMDocumentSequence    *newInterface;
IOpcPartUri               *partUri;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

hr = CoCreateInstance(
    __uuidof(XpsOMObjectFactory),
    NULL,
    CLSCTX_INPROC_SERVER,
    _uuidof(IXpsOMObjectFactory),
    reinterpret_cast<LPVOID*>(&xpsFactory)
    );

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreatePartUri(partUriString, &partUri);
    
    if (SUCCEEDED(hr))
    {
        hr = xpsFactory->CreateDocumentSequence (partUri, &newInterface);

        if (SUCCEEDED(hr))
        {
            // use newInterface

            newInterface->Release();
        }
        partUri->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}


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

IXpsOMObjectFactory::CreateDocumentSequence
Interfaces
XML Paper Specification

 

 

Community Additions

ADD
Show:
© 2014 Microsoft