ControllerLinkGeneratorExtensions.GetUriByAction Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Перегрузки
GetUriByAction(LinkGenerator, String, String, Object, String, HostString, PathString, FragmentString, LinkOptions) |
Создает абсолютный URI на основе предоставленных значений. |
GetUriByAction(LinkGenerator, HttpContext, String, String, Object, String, Nullable<HostString>, Nullable<PathString>, FragmentString, LinkOptions) |
Создает абсолютный URI на основе предоставленных значений. |
GetUriByAction(LinkGenerator, String, String, Object, String, HostString, PathString, FragmentString, LinkOptions)
- Исходный код:
- ControllerLinkGeneratorExtensions.cs
- Исходный код:
- ControllerLinkGeneratorExtensions.cs
Создает абсолютный URI на основе предоставленных значений.
public static string GetUriByAction (this Microsoft.AspNetCore.Routing.LinkGenerator generator, string action, string controller, 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? GetUriByAction (this Microsoft.AspNetCore.Routing.LinkGenerator generator, string action, string controller, 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? GetUriByAction (this Microsoft.AspNetCore.Routing.LinkGenerator generator, string action, string controller, 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 GetUriByAction : Microsoft.AspNetCore.Routing.LinkGenerator * string * string * obj * string * Microsoft.AspNetCore.Http.HostString * Microsoft.AspNetCore.Http.PathString * Microsoft.AspNetCore.Http.FragmentString * Microsoft.AspNetCore.Routing.LinkOptions -> string
<Extension()>
Public Function GetUriByAction (generator As LinkGenerator, action As String, controller 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 String
Параметры
- generator
- LinkGenerator
- action
- String
Имя действия. Используется для разрешения конечных точек.
- controller
- String
Имя контроллера. Используется для разрешения конечных точек.
- values
- Object
Значения маршрута. Может принимать значение NULL. Используется для разрешения конечных точек и развертывания параметров в шаблоне маршрута.
- scheme
- String
Схема URI, примененная к результирующему URI.
- host
- HostString
Узел или центр URI, примененный к результирующему URI.
- pathBase
- PathString
Необязательный путь URI. Добавляется к пути в результирующем универсальном коде ресурса (URI).
- fragment
- FragmentString
Фрагмент URI. Необязательный элемент. Добавляется к результирующему URI.
- options
- LinkOptions
Необязательный класс LinkOptions. Параметры предоставленного объекта переопределяют параметры с соответствующими именами из RouteOptions
.
Возвращаемое значение
Абсолютный URI или null
значение , если не удается создать URI.
Комментарии
Значение host
должно быть доверенным значением. Использование значения текущего запроса может позволить ненадежным входным данным влиять на результирующий URI, если Host
заголовок не был проверен. Инструкции по правильной проверке заголовка Host
в среде развертывания см. в документации по развертыванию.
Применяется к
GetUriByAction(LinkGenerator, HttpContext, String, String, Object, String, Nullable<HostString>, Nullable<PathString>, FragmentString, LinkOptions)
- Исходный код:
- ControllerLinkGeneratorExtensions.cs
- Исходный код:
- ControllerLinkGeneratorExtensions.cs
Создает абсолютный URI на основе предоставленных значений.
public static string GetUriByAction (this Microsoft.AspNetCore.Routing.LinkGenerator generator, Microsoft.AspNetCore.Http.HttpContext httpContext, string action = default, string controller = default, object 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);
public static string? GetUriByAction (this Microsoft.AspNetCore.Routing.LinkGenerator generator, Microsoft.AspNetCore.Http.HttpContext httpContext, string? action = default, string? controller = default, object? 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 GetUriByAction : Microsoft.AspNetCore.Routing.LinkGenerator * Microsoft.AspNetCore.Http.HttpContext * string * 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 GetUriByAction (generator As LinkGenerator, httpContext As HttpContext, Optional action As String = Nothing, Optional controller As String = Nothing, Optional values As Object = 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 String
Параметры
- generator
- LinkGenerator
- httpContext
- HttpContext
Объект , HttpContext связанный с текущим запросом.
- action
- String
Имя действия. Используется для разрешения конечных точек. Необязательный элемент. Если null
указан параметр , будет использоваться текущее значение маршрута действия.
- controller
- String
Имя контроллера. Используется для разрешения конечных точек. Необязательный элемент. Если null
указан параметр , будет использоваться текущее значение маршрута контроллера.
- values
- Object
Значения маршрута. Необязательный элемент. Используется для разрешения конечных точек и развертывания параметров в шаблоне маршрута.
- scheme
- String
Схема URI, примененная к результирующему URI. Необязательный элемент. Если этот параметр не указан, будет использоваться значение Scheme .
- host
- Nullable<HostString>
Узел или центр URI, примененный к результирующему URI. Необязательный элемент. Если значение не указано, будет использоваться значение Host .
- pathBase
- Nullable<PathString>
Необязательный путь URI. Добавляется к пути в результирующем универсальном коде ресурса (URI). Если этот параметр не указан, будет использоваться значение PathBase .
- fragment
- FragmentString
Фрагмент URI. Необязательный элемент. Добавляется к результирующему URI.
- options
- LinkOptions
Необязательный класс LinkOptions. Параметры предоставленного объекта переопределяют параметры с соответствующими именами из RouteOptions
.
Возвращаемое значение
Абсолютный URI или null
значение , если не удается создать URI.
Комментарии
Значение host
должно быть доверенным значением. Использование значения текущего запроса может позволить ненадежным входным данным влиять на результирующий URI, если Host
заголовок не был проверен. Инструкции по правильной проверке заголовка Host
в среде развертывания см. в документации по развертыванию.