Share via

HttpRouteCollectionExtensions.MapHttpRoute Method (HttpRouteCollection, String, String)

Maps the specified route template.

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 _
) As IHttpRoute
Dim routes As HttpRouteCollection 
Dim name As String 
Dim routeTemplate As String 
Dim returnValue As IHttpRoute 

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


  • routeTemplate
    Type: System.String
    The route template for the route.

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


For an overview of Web API routing, see Routing in ASP.NET Web API. For more details, see Routing and Action Selection.

See Also


HttpRouteCollectionExtensions Class

MapHttpRoute Overload

System.Web.Http Namespace