IXpsOMObjectFactory::CreateDocumentSequence method (xpsobjectmodel.h)

Creates an IXpsOMDocumentSequence interface, which can contain the IXpsOMDocument interfaces of the XPS document.

Syntax

HRESULT CreateDocumentSequence(
  [in]          IOpcPartUri            *partUri,
  [out, retval] IXpsOMDocumentSequence **documentSequence
);

Parameters

[in] partUri

A pointer to the IOpcPartUri interface that contains the part name to be assigned to this resource. This parameter must not be NULL.

[out, retval] documentSequence

A pointer to the new IXpsOMDocumentSequence interface.

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.

Remarks

The code example that follows illustrates how this method is used to create a new 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

See also

IOpcPartUri

IXpsOMDocument

IXpsOMDocumentSequence

IXpsOMObjectFactory

XML Paper Specification

XPS Document Errors