HttpRouteCollectionExtensions.MapHttpRoute Method (HttpRouteCollection, String, String, Object, Object, )

Maps the specified route template and sets default route values, constraints, and end-point message handler.

Namespace:  System.Web.Http
Assembly:  System.Web.Http (in System.Web.Http.dll)


<ExtensionAttribute> _
Public Shared Function MapHttpRoute ( _
    routes As HttpRouteCollection, _
    name As String, _
    routeTemplate As String, _
    defaults As Object, _
    constraints As Object, _
    handler As HttpMessageHandler _
) As IHttpRoute
Dim routes As HttpRouteCollection 
Dim name As String 
Dim routeTemplate As String 
Dim defaults As Object 
Dim constraints As Object 
Dim handler As HttpMessageHandler 
Dim returnValue As IHttpRoute 

returnValue = routes.MapHttpRoute(name, _
    routeTemplate, defaults, constraints, _
public static IHttpRoute MapHttpRoute(
    this HttpRouteCollection routes,
    string name,
    string routeTemplate,
    Object defaults,
    Object constraints,
    HttpMessageHandler handler
static IHttpRoute^ MapHttpRoute(
    HttpRouteCollection^ routes, 
    String^ name, 
    String^ routeTemplate, 
    Object^ defaults, 
    Object^ constraints, 
    HttpMessageHandler^ handler
static member MapHttpRoute : 
        routes:HttpRouteCollection * 
        name:string * 
        routeTemplate:string * 
        defaults:Object * 
        constraints:Object * 
        handler:HttpMessageHandler -> IHttpRoute
public static function MapHttpRoute(
    routes : HttpRouteCollection, 
    name : String, 
    routeTemplate : String, 
    defaults : Object, 
    constraints : Object, 
    handler : HttpMessageHandler
) : IHttpRoute


  • routeTemplate
    Type: System.String

    The route template for the route.

  • defaults
    Type: System.Object

    An object that contains default route values.

  • constraints
    Type: System.Object

    A set of expressions that constrain the values for routeTemplate.

  • handler
    Type: HttpMessageHandler

    The handler to which the request will be dispatched.

Return Value

Type: System.Web.Http.Routing.IHttpRoute
A reference to the mapped route.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type HttpRouteCollection. When you use instance method syntax to call this method, omit the first parameter. For more information, see or

See Also


HttpRouteCollectionExtensions Class

MapHttpRoute Overload

System.Web.Http Namespace