HttpListenerResponse.RedirectLocation Property

Reference

Definition

Namespace:: System.Net

Assembly:: System.Net.HttpListener.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: HttpListenerResponse.cs

Source:: HttpListenerResponse.cs

Source:: HttpListenerResponse.cs

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.

Gets or sets the value of the HTTP Location header in this response.

public:
 property System::String ^ RedirectLocation { System::String ^ get(); void set(System::String ^ value); };

public string? RedirectLocation { get; set; }

public string RedirectLocation { get; set; }

member this.RedirectLocation : string with get, set

Public Property RedirectLocation As String

Property Value

String

A String that contains the absolute URL to be sent to the client in the Location header.

Exceptions

ArgumentException

The value specified for a set operation is an empty string ("").

ObjectDisposedException

This object is closed.

Examples

The following code example demonstrates setting this property.

public static void TemporaryRedirect(HttpListenerRequest request, HttpListenerResponse response)
{
    if (request.Url.OriginalString == @"http://www.contoso.com/index.html")
    {
        response.RedirectLocation = @"http://www.contoso.com/indexServer/index.html";
    }
}

Public Shared Sub TemporaryRedirect(ByVal request As HttpListenerRequest, ByVal response As HttpListenerResponse)
    If request.Url.OriginalString = "http://www.contoso.com/index.html" Then
        response.RedirectLocation = "http://www.contoso.com/indexServer/index.html"
    End If
End Sub

Remarks

The Location header specifies the URL to which the client is directed to locate a requested resource.

Note

Setting this property does not automatically set the StatusCode property.

Applies to