Sdílet prostřednictvím

HttpListenerResponse.StatusCode Vlastnost

  • Reference

Definice

Obor názvů:
System.Net
Sestavení:
System.Net.HttpListener.dll
Sestavení:
System.dll
Sestavení:
netstandard.dll
Zdroj:
HttpListenerResponse.Managed.cs
Zdroj:
HttpListenerResponse.Managed.cs
Zdroj:
HttpListenerResponse.Managed.cs

Získá nebo nastaví stavový kód HTTP, který má být vrácen klientovi.

public:
 property int StatusCode { int get(); void set(int value); };
public int StatusCode { get; set; }
member this.StatusCode : int with get, set
Public Property StatusCode As Integer

Hodnota vlastnosti

Int32

Hodnota Int32 , která určuje stavový kód HTTP pro požadovaný prostředek. Výchozí hodnota je OK, což znamená, že server úspěšně zpracoval požadavek klienta a zahrnul požadovaný prostředek do textu odpovědi.

Výjimky

ObjectDisposedException

Tento objekt je zavřený.

ProtocolViolationException

Hodnota zadaná pro operaci sady není platná. Platné hodnoty jsou mezi 100 a 999 včetně.

Příklady

Následující příklad kódu ukazuje nastavení hodnoty této vlastnosti.


// When the client is not authenticated, there is no Identity.
if (context.User == null)
{
    message.Append ("<HTML><BODY><p> Hello local user! </p></BODY></HTML>");
}
else
{
    // Get the requester's identity.
    System.Security.Principal.WindowsIdentity identity = WindowsIdentity.GetCurrent();
    // Construct the response body.
    message.AppendFormat ("<HTML><BODY><p> Hello {0}!<br/>",
        identity.Name);
    message.AppendFormat ("You were authenticated using {0}.</p>",
        identity.AuthenticationType);
    message.Append ("</BODY></HTML>");
}

// Configure the response.
HttpListenerResponse response = context.Response;

// Use the encoding from the response if one has been set.
// Otherwise, use UTF8.
System.Text.Encoding encoding = response.ContentEncoding;
if (encoding == null)
{
    encoding = System.Text.Encoding.UTF8;
    response.ContentEncoding = encoding;
}
byte[] buffer = encoding.GetBytes (message.ToString ());
response.ContentLength64 = buffer.Length;
response.StatusCode = (int) HttpStatusCode.OK;
response.StatusDescription = "OK";
response.ProtocolVersion = new Version ("1.1");
// Don't keep the TCP connection alive;
// We don't expect multiple requests from the same client.
response.KeepAlive = false;
// Write the response body.
System.IO.Stream stream = response.OutputStream;
stream.Write(buffer, 0, buffer.Length);


' When the client is not authenticated, there is no Identity.
If context.User Is Nothing Then
    message.Append("<HTML><BODY><p> Hello local user! </p></BODY></HTML>")
Else
    ' Get the requester's identity.
    Dim identity As System.Security.Principal.WindowsIdentity = WindowsIdentity.GetCurrent()
    ' Construct the response body.
    message.AppendFormat("<HTML><BODY><p> Hello {0}!<br/>", identity.Name)
    message.AppendFormat("You were authenticated using {0}.</p>", identity.AuthenticationType)
    message.Append("</BODY></HTML>")
End If

' Configure the response.
Dim response As HttpListenerResponse = context.Response

' Use the encoding from the response if one has been set.
' Otherwise, use UTF8.
Dim encoding As System.Text.Encoding = response.ContentEncoding
If encoding Is Nothing Then
    encoding = System.Text.Encoding.UTF8
    response.ContentEncoding = encoding
End If
Dim buffer() As Byte = encoding.GetBytes(message.ToString())
response.ContentLength64 = buffer.Length
response.StatusCode = CInt(HttpStatusCode.OK)
response.StatusDescription = "OK"
response.ProtocolVersion = New Version("1.1")
' Don't keep the TCP connection alive
' We don't expect multiple requests from the same client.
response.KeepAlive = False
' Write the response body.
Dim stream As System.IO.Stream = response.OutputStream
stream.Write(buffer, 0, buffer.Length)

Poznámky

Klienti používají stavový kód vrácený serverem k rozhodnutí, jak pokračovat. Hodnota označuje OK , že server úspěšně zpracoval požadavek klienta a zahrnul požadovaný prostředek do textu odpovědi. Mezi další běžné stavové kódy patří NotFound, které označují, že požadovaný prostředek nebyl na serveru nalezen, a NotModified, označující, že nebylo nutné vracet požadovaný prostředek v těle odpovědi, protože kopie prostředku v mezipaměti klienta je aktuální.

Úplný seznam možných stavových kódů najdete ve výčtu HttpStatusCode .

Platí pro

Viz také