LinkGeneratorEndpointNameAddressExtensions.GetUriByName Method
Definition
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.
Overloads
| GetUriByName(LinkGenerator, String, RouteValueDictionary, String, HostString, PathString, FragmentString, LinkOptions) |
Generates an absolute URI based on the provided values. |
| GetUriByName(LinkGenerator, String, Object, String, HostString, PathString, FragmentString, LinkOptions) |
Generates an absolute URI based on the provided values. |
| GetUriByName(LinkGenerator, HttpContext, String, RouteValueDictionary, String, Nullable<HostString>, Nullable<PathString>, FragmentString, LinkOptions) |
Generates an absolute URI based on the provided values. |
| GetUriByName(LinkGenerator, HttpContext, String, Object, String, Nullable<HostString>, Nullable<PathString>, FragmentString, LinkOptions) |
Generates an absolute URI based on the provided values. |
GetUriByName(LinkGenerator, String, RouteValueDictionary, String, HostString, PathString, FragmentString, LinkOptions)
Generates an absolute URI based on the provided values.
public static string? GetUriByName (this Microsoft.AspNetCore.Routing.LinkGenerator generator, string endpointName, Microsoft.AspNetCore.Routing.RouteValueDictionary values, string scheme, Microsoft.AspNetCore.Http.HostString host, Microsoft.AspNetCore.Http.PathString pathBase = default, Microsoft.AspNetCore.Http.FragmentString fragment = default, Microsoft.AspNetCore.Routing.LinkOptions? options = default);static member GetUriByName : Microsoft.AspNetCore.Routing.LinkGenerator * string * Microsoft.AspNetCore.Routing.RouteValueDictionary * string * Microsoft.AspNetCore.Http.HostString * Microsoft.AspNetCore.Http.PathString * Microsoft.AspNetCore.Http.FragmentString * Microsoft.AspNetCore.Routing.LinkOptions -> string<Extension()>
Public Function GetUriByName (generator As LinkGenerator, endpointName As String, values As RouteValueDictionary, scheme As String, host As HostString, Optional pathBase As PathString = Nothing, Optional fragment As FragmentString = Nothing, Optional options As LinkOptions = Nothing) As StringParameters
- generator
- LinkGenerator
The LinkGenerator.
- endpointName
- String
The endpoint name. Used to resolve endpoints.
- values
- RouteValueDictionary
The route values. Used to expand parameters in the route template.
- scheme
- String
The URI scheme, applied to the resulting URI.
- host
- HostString
The URI host/authority, applied to the resulting URI.
See the remarks section for details about the security implications of the host.
- pathBase
- PathString
An optional URI path base. Prepended to the path in the resulting URI.
- fragment
- FragmentString
An optional URI fragment. Appended to the resulting URI.
- options
- LinkOptions
An optional LinkOptions. Settings on provided object override the settings with matching
names from RouteOptions.
Returns
An absolute URI, or null.
Remarks
The value of host should be a trusted value. Relying on the value of the current request can allow untrusted input to influence the resulting URI unless the Host header has been validated. See the deployment documentation for instructions on how to properly validate the Host header in your deployment environment.
Applies to
GetUriByName(LinkGenerator, String, Object, String, HostString, PathString, FragmentString, LinkOptions)
Generates an absolute URI based on the provided values.
public static string GetUriByName (this Microsoft.AspNetCore.Routing.LinkGenerator generator, string endpointName, object values, string scheme, Microsoft.AspNetCore.Http.HostString host, Microsoft.AspNetCore.Http.PathString pathBase = default, Microsoft.AspNetCore.Http.FragmentString fragment = default, Microsoft.AspNetCore.Routing.LinkOptions options = default);public static string? GetUriByName (this Microsoft.AspNetCore.Routing.LinkGenerator generator, string endpointName, object? values, string scheme, Microsoft.AspNetCore.Http.HostString host, Microsoft.AspNetCore.Http.PathString pathBase = default, Microsoft.AspNetCore.Http.FragmentString fragment = default, Microsoft.AspNetCore.Routing.LinkOptions? options = default);static member GetUriByName : Microsoft.AspNetCore.Routing.LinkGenerator * string * obj * string * Microsoft.AspNetCore.Http.HostString * Microsoft.AspNetCore.Http.PathString * Microsoft.AspNetCore.Http.FragmentString * Microsoft.AspNetCore.Routing.LinkOptions -> string<Extension()>
Public Function GetUriByName (generator As LinkGenerator, endpointName As String, values As Object, scheme As String, host As HostString, Optional pathBase As PathString = Nothing, Optional fragment As FragmentString = Nothing, Optional options As LinkOptions = Nothing) As StringParameters
- generator
- LinkGenerator
The LinkGenerator.
- endpointName
- String
The endpoint name. Used to resolve endpoints.
- values
- Object
The route values. Used to expand parameters in the route template. Optional.
- scheme
- String
The URI scheme, applied to the resulting URI.
- host
- HostString
The URI host/authority, applied to the resulting URI.
See the remarks section for details about the security implications of the host.
- pathBase
- PathString
An optional URI path base. Prepended to the path in the resulting URI.
- fragment
- FragmentString
An optional URI fragment. Appended to the resulting URI.
- options
- LinkOptions
An optional LinkOptions. Settings on provided object override the settings with matching
names from RouteOptions.
Returns
An absolute URI, or null.
Remarks
The value of host should be a trusted value. Relying on the value of the current request can allow untrusted input to influence the resulting URI unless the Host header has been validated. See the deployment documentation for instructions on how to properly validate the Host header in your deployment environment.
Applies to
GetUriByName(LinkGenerator, HttpContext, String, RouteValueDictionary, String, Nullable<HostString>, Nullable<PathString>, FragmentString, LinkOptions)
Generates an absolute URI based on the provided values.
public static string? GetUriByName (this Microsoft.AspNetCore.Routing.LinkGenerator generator, Microsoft.AspNetCore.Http.HttpContext httpContext, string endpointName, Microsoft.AspNetCore.Routing.RouteValueDictionary? values = default, string? scheme = default, Microsoft.AspNetCore.Http.HostString? host = default, Microsoft.AspNetCore.Http.PathString? pathBase = default, Microsoft.AspNetCore.Http.FragmentString fragment = default, Microsoft.AspNetCore.Routing.LinkOptions? options = default);static member GetUriByName : Microsoft.AspNetCore.Routing.LinkGenerator * Microsoft.AspNetCore.Http.HttpContext * string * Microsoft.AspNetCore.Routing.RouteValueDictionary * string * Nullable<Microsoft.AspNetCore.Http.HostString> * Nullable<Microsoft.AspNetCore.Http.PathString> * Microsoft.AspNetCore.Http.FragmentString * Microsoft.AspNetCore.Routing.LinkOptions -> string<Extension()>
Public Function GetUriByName (generator As LinkGenerator, httpContext As HttpContext, endpointName As String, Optional values As RouteValueDictionary = Nothing, Optional scheme As String = Nothing, Optional host As Nullable(Of HostString) = Nothing, Optional pathBase As Nullable(Of PathString) = Nothing, Optional fragment As FragmentString = Nothing, Optional options As LinkOptions = Nothing) As StringParameters
- generator
- LinkGenerator
The LinkGenerator.
- httpContext
- HttpContext
The HttpContext associated with the current request.
- endpointName
- String
The endpoint name. Used to resolve endpoints.
- values
- RouteValueDictionary
The route values. Used to expand parameters in the route template. Optional.
- scheme
- String
The URI scheme, applied to the resulting URI. Optional. If not provided, the value of Scheme will be used.
- host
- Nullable<HostString>
The URI host/authority, applied to the resulting URI. Optional. If not provided, the value Host will be used.
See the remarks section for details about the security implications of the host.
- pathBase
- Nullable<PathString>
An optional URI path base. Prepended to the path in the resulting URI. If not provided, the value of PathBase will be used.
- fragment
- FragmentString
An optional URI fragment. Appended to the resulting URI.
- options
- LinkOptions
An optional LinkOptions. Settings on provided object override the settings with matching
names from RouteOptions.
Returns
A URI with an absolute path, or null.
Remarks
The value of host should be a trusted value. Relying on the value of the current request can allow untrusted input to influence the resulting URI unless the Host header has been validated. See the deployment documentation for instructions on how to properly validate the Host header in your deployment environment.
Applies to
GetUriByName(LinkGenerator, HttpContext, String, Object, String, Nullable<HostString>, Nullable<PathString>, FragmentString, LinkOptions)
Generates an absolute URI based on the provided values.
public static string GetUriByName (this Microsoft.AspNetCore.Routing.LinkGenerator generator, Microsoft.AspNetCore.Http.HttpContext httpContext, string endpointName, object values, string scheme = default, Microsoft.AspNetCore.Http.HostString? host = default, Microsoft.AspNetCore.Http.PathString? pathBase = default, Microsoft.AspNetCore.Http.FragmentString fragment = default, Microsoft.AspNetCore.Routing.LinkOptions options = default);public static string? GetUriByName (this Microsoft.AspNetCore.Routing.LinkGenerator generator, Microsoft.AspNetCore.Http.HttpContext httpContext, string endpointName, object? values, string? scheme = default, Microsoft.AspNetCore.Http.HostString? host = default, Microsoft.AspNetCore.Http.PathString? pathBase = default, Microsoft.AspNetCore.Http.FragmentString fragment = default, Microsoft.AspNetCore.Routing.LinkOptions? options = default);static member GetUriByName : Microsoft.AspNetCore.Routing.LinkGenerator * Microsoft.AspNetCore.Http.HttpContext * string * obj * string * Nullable<Microsoft.AspNetCore.Http.HostString> * Nullable<Microsoft.AspNetCore.Http.PathString> * Microsoft.AspNetCore.Http.FragmentString * Microsoft.AspNetCore.Routing.LinkOptions -> string<Extension()>
Public Function GetUriByName (generator As LinkGenerator, httpContext As HttpContext, endpointName As String, values As Object, Optional scheme As String = Nothing, Optional host As Nullable(Of HostString) = Nothing, Optional pathBase As Nullable(Of PathString) = Nothing, Optional fragment As FragmentString = Nothing, Optional options As LinkOptions = Nothing) As StringParameters
- generator
- LinkGenerator
The LinkGenerator.
- httpContext
- HttpContext
The HttpContext associated with the current request.
- endpointName
- String
The endpoint name. Used to resolve endpoints.
- values
- Object
The route values. Used to expand parameters in the route template. Optional.
- scheme
- String
The URI scheme, applied to the resulting URI. Optional. If not provided, the value of Scheme will be used.
- host
- Nullable<HostString>
The URI host/authority, applied to the resulting URI. Optional. If not provided, the value Host will be used.
See the remarks section for details about the security implications of the host.
- pathBase
- Nullable<PathString>
An optional URI path base. Prepended to the path in the resulting URI. If not provided, the value of PathBase will be used.
- fragment
- FragmentString
An optional URI fragment. Appended to the resulting URI.
- options
- LinkOptions
An optional LinkOptions. Settings on provided object override the settings with matching
names from RouteOptions.
Returns
A URI with an absolute path, or null.
Remarks
The value of host should be a trusted value. Relying on the value of the current request can allow untrusted input to influence the resulting URI unless the Host header has been validated. See the deployment documentation for instructions on how to properly validate the Host header in your deployment environment.
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for