IRouteConstraint.Match Method

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Routing
Assembly:
Microsoft.AspNetCore.Routing.Abstractions.dll
Package:
Microsoft.AspNetCore.Routing.Abstractions v1.0.0
Package:
Microsoft.AspNetCore.Routing.Abstractions v1.1.0
Package:
Microsoft.AspNetCore.Routing.Abstractions v2.0.0
Package:
Microsoft.AspNetCore.Routing.Abstractions v2.1.0
Package:
Microsoft.AspNetCore.Routing.Abstractions v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3
Source:
IRouteConstraint.cs

Determines whether the URL parameter contains a valid value for this constraint.

public:
 bool Match(Microsoft::AspNetCore::Http::HttpContext ^ httpContext, Microsoft::AspNetCore::Routing::IRouter ^ route, System::String ^ routeKey, Microsoft::AspNetCore::Routing::RouteValueDictionary ^ values, Microsoft::AspNetCore::Routing::RouteDirection routeDirection);
public bool Match (Microsoft.AspNetCore.Http.HttpContext httpContext, Microsoft.AspNetCore.Routing.IRouter route, string routeKey, Microsoft.AspNetCore.Routing.RouteValueDictionary values, Microsoft.AspNetCore.Routing.RouteDirection routeDirection);
public bool Match (Microsoft.AspNetCore.Http.HttpContext? httpContext, Microsoft.AspNetCore.Routing.IRouter? route, string routeKey, Microsoft.AspNetCore.Routing.RouteValueDictionary values, Microsoft.AspNetCore.Routing.RouteDirection routeDirection);
abstract member Match : Microsoft.AspNetCore.Http.HttpContext * Microsoft.AspNetCore.Routing.IRouter * string * Microsoft.AspNetCore.Routing.RouteValueDictionary * Microsoft.AspNetCore.Routing.RouteDirection -> bool
Public Function Match (httpContext As HttpContext, route As IRouter, routeKey As String, values As RouteValueDictionary, routeDirection As RouteDirection) As Boolean

Parameters

httpContext
HttpContext

An object that encapsulates information about the HTTP request.

route
IRouter

The router that this constraint belongs to.

routeKey
String

The name of the parameter that is being checked.

values
RouteValueDictionary

A dictionary that contains the parameters for the URL.

routeDirection
RouteDirection

An object that indicates whether the constraint check is being performed when an incoming request is being handled or when a URL is being generated.

Returns

Boolean

true if the URL parameter contains a valid value; otherwise, false.

Applies to