DocumentSet.TryGetCollection MethodDocumentSet.TryGetCollection MethodDocumentSet::TryGetCollection Method
- XmlPrime 4.0
- Other Versions ▼
Syntax
Public Function TryGetCollection( _ uri As AnyUri, _ <Out>collection As ByRef IResolvedCollection _ ) As Boolean
public bool TryGetCollection( AnyUri uri, out IResolvedCollection collection )
public: bool TryGetCollection( AnyUri^ uri, [Out] IResolvedCollection^% collection )
Parameters
- uri
Type: XmlPrime.AnyUriXmlPrime.AnyUriXmlPrime::AnyUri^
The URI of the collection to retrieve, or
null
a null reference (Nothing
in Visual Basic)nullptr
to retrieve the default collection.- collection
Type: out XmlPrime.IResolvedCollectionByRef XmlPrime.IResolvedCollectionXmlPrime::IResolvedCollection^%
When this method returns, contains the collection at the specified URI, if it is cached in the DocumentSetDocumentSetDocumentSet; otherwise
null
a null reference (Nothing
in Visual Basic)nullptr
. This is also set tonull
a null reference (Nothing
in Visual Basic)nullptr
if the URI is marked as unavailable.
Return Value
Type: System.BooleanSystem.BooleanSystem::Boolean
true
True
true
if the DocumentSetDocumentSetDocumentSet contains the specified collection, or the URI is
marked as unavailable; otherwise false
False
false
.
Exceptions
Exception | Condition |
ArgumentNullExceptionArgumentNullExceptionArgumentNullException | uri is null
a null reference (Nothing in Visual Basic)
nullptr . |
ArgumentExceptionArgumentExceptionArgumentException | uri is not an absolute URI. |