UriTemplate.Match Method (Uri, ICollection(String))

UriTemplateMatch Method (Uri, ICollectionString)

This API is preliminary and subject to change.

Attempts to match a Uri to a UriTemplate.

Namespace: Rackspace.Net
Assembly: Rackspace.Net.UriTemplate (in Rackspace.Net.UriTemplate.dll) Version: 1.0.0.0-beta003

Syntax

C++

Copy

public UriTemplateMatch Match(
	Uri candidate,
	ICollection<string> requiredVariables
)

Public Function Match ( 
	candidate As Uri,
	requiredVariables As ICollection(Of String)
) As UriTemplateMatch

public:
UriTemplateMatch^ Match(
	Uri^ candidate, 
	ICollection<String^>^ requiredVariables
)

member Match : 
        candidate : Uri * 
        requiredVariables : ICollection<string> -> UriTemplateMatch

Parameters

candidate: Type: SystemUri
The Uri to match against the template.
requiredVariables: Type: System.Collections.GenericICollectionString
A collection of variables which must be provided during the expansion process for the resulting URI to be valid.

Return Value

Type: UriTemplateMatch
A UriTemplateMatch object containing the results of the match operation, or if the match failed. The default value is an empty collection.

Exceptions