LinkParserEndpointNameAddressExtensions.ParsePathByEndpointName Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Routing

Assembly:: Microsoft.AspNetCore.Routing.dll

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

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Attempts to parse the provided path using the route pattern specified by the Endpoint matching endpointName.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Routing::RouteValueDictionary ^ ParsePathByEndpointName(Microsoft::AspNetCore::Routing::LinkParser ^ parser, System::String ^ endpointName, Microsoft::AspNetCore::Http::PathString path);

public static Microsoft.AspNetCore.Routing.RouteValueDictionary ParsePathByEndpointName (this Microsoft.AspNetCore.Routing.LinkParser parser, string endpointName, Microsoft.AspNetCore.Http.PathString path);

public static Microsoft.AspNetCore.Routing.RouteValueDictionary? ParsePathByEndpointName (this Microsoft.AspNetCore.Routing.LinkParser parser, string endpointName, Microsoft.AspNetCore.Http.PathString path);

static member ParsePathByEndpointName : Microsoft.AspNetCore.Routing.LinkParser * string * Microsoft.AspNetCore.Http.PathString -> Microsoft.AspNetCore.Routing.RouteValueDictionary

<Extension()>
Public Function ParsePathByEndpointName (parser As LinkParser, endpointName As String, path As PathString) As RouteValueDictionary

Parameters

parser: LinkParser

The LinkParser.

endpointName: String

The endpoint name. Used to resolve endpoints.

path: PathString

The URI path to parse.

Returns

RouteValueDictionary

A RouteValueDictionary with the parsed values if parsing is successful; otherwise null.

Remarks

ParsePathByEndpointName(LinkParser, String, PathString) will attempt to first resolve Endpoint instances that match endpointName and then use the route pattern associated with each endpoint to parse the URL path.

The parsing operation will fail and return null if either no endpoints are found or none of the route patterns match the provided URI path.

Applies to