ICollectionResolver.ResolveCollection MethodICollectionResolver.ResolveCollection MethodICollectionResolver::ResolveCollection Method

Resolves a URI to a collection, or resolves the default collection.

Syntax

Function ResolveCollection( _
    uri As AnyUri, _
    documentSet As DocumentSet, _
    nameTable As System.Xml.XmlNameTable, _
    inputSettings As InputSettings _
) As IResolvedCollection
IResolvedCollection ResolveCollection(
    AnyUri uri,
    DocumentSet documentSet,
    System.Xml.XmlNameTable nameTable,
    InputSettings inputSettings
)
IResolvedCollection^ ResolveCollection(
    AnyUri^ uri, 
    DocumentSet^ documentSet, 
    System.Xml::XmlNameTable^ nameTable, 
    InputSettings^ inputSettings
)
 

Parameters

uri

Type: XmlPrime.AnyUriXmlPrime.AnyUriXmlPrime::AnyUri^

The absolute URI of the document to resolve, or null a null reference (Nothing in Visual Basic) nullptr to resolve the default collection.

documentSet

Type: XmlPrime.DocumentSetXmlPrime.DocumentSetXmlPrime::DocumentSet^

The document set that should be used to retrieve documents.

nameTable

Type: System.Xml.XmlNameTableSystem.Xml.XmlNameTableSystem.Xml::XmlNameTable^

The name table to use to load nodes.

inputSettings

Type: XmlPrime.InputSettingsXmlPrime.InputSettingsXmlPrime::InputSettings^

The filters to be applied to the source documents.

Return Value

Type: XmlPrime.IResolvedCollectionXmlPrime.IResolvedCollectionXmlPrime::IResolvedCollection^

An array of IXPathNavigableIXPathNavigableIXPathNavigable instances representing the collection, or null a null reference (Nothing in Visual Basic) nullptr if the URI can not be mapped to a collection.

Exceptions

ExceptionCondition
ExceptionExceptionExceptionAn error occurred retrieving the collection.

Remarks

Any documents with document URIs must have been retrieved from the document set.

A return value of null a null reference (Nothing in Visual Basic) nullptr indicates that uri is not supported by this resolver (for example an unsupported URI scheme). If the URI does have meaning to this resolver but there was an error retrieving the document then an exception should be thrown.