แก้ไข

แชร์ผ่าน

HttpListenerResponse.OutputStream 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

Gets a Stream object to which a response can be written.

public:
 property System::IO::Stream ^ OutputStream { System::IO::Stream ^ get(); };
public System.IO.Stream OutputStream { get; }
member this.OutputStream : System.IO.Stream
Public ReadOnly Property OutputStream As Stream

Property Value

Stream

A Stream object to which a response can be written.

Exceptions

ObjectDisposedException

This object is closed.

Examples

The following code example demonstrates calling this method.

// This example requires the System and System.Net namespaces.
public static string ClientInformation(HttpListenerContext context)
{
    System.Security.Principal.IPrincipal user = context.User;
    System.Security.Principal.IIdentity id = user.Identity;
    if (id == null)
    {
        return "Client authentication is not enabled for this Web server.";
    }

    string display;
    if (id.IsAuthenticated)
    {
        display = String.Format("{0} was authenticated using {1}", id.Name,
            id.AuthenticationType);
    }
    else
    {
       display = String.Format("{0} was not authenticated", id.Name);
    }
    return display;
}

public static void SimpleListenerWithAuthentication(string[] prefixes)
{
    if (!HttpListener.IsSupported)
    {
        Console.WriteLine ("Windows XP SP2 or Server 2003 is required to use the HttpListener class.");
        return;
    }

    // URI prefixes are required,
    // for example "http://contoso.com:8080/index/".
    if (prefixes == null || prefixes.Length == 0)
      throw new ArgumentException("prefixes");

    // Set up a listener.
    HttpListener listener = new HttpListener();
    foreach (string s in prefixes)
    {
        listener.Prefixes.Add(s);
    }
    listener.Start();
    // Specify Negotiate as the authentication scheme.
    listener.AuthenticationSchemes = AuthenticationSchemes.Negotiate;
    Console.WriteLine("Listening...");
    // GetContext blocks while waiting for a request.
    HttpListenerContext context = listener.GetContext();
    HttpListenerRequest request = context.Request;
    // Obtain a response object.
    HttpListenerResponse response = context.Response;
    // Construct a response.
    string clientInformation = ClientInformation(context);
    byte[] buffer = System.Text.Encoding.UTF8.GetBytes("<HTML><BODY> " + clientInformation + "</BODY></HTML>");
    // Get a response stream and write the response to it.
    response.ContentLength64 = buffer.Length;
    System.IO.Stream output = response.OutputStream;
    output.Write(buffer,0,buffer.Length);
    output.Close();
    listener.Stop();
}

' This example requires the System and System.Net namespaces.
Public Shared Function ClientInformation(ByVal context As HttpListenerContext) As String
    Dim user As System.Security.Principal.IPrincipal = context.User
    Dim id As System.Security.Principal.IIdentity = user.Identity

    If id Is Nothing Then
        Return "Client authentication is not enabled for this Web server."
    End If

    Dim display As String

    If id.IsAuthenticated Then
        display = String.Format("{0} was authenticated using {1}", id.Name, id.AuthenticationType)
    Else
        display = String.Format("{0} was not authenticated", id.Name)
    End If

    Return display
End Function

Public Shared Sub SimpleListenerWithAuthentication(ByVal prefixes As String())
    If Not HttpListener.IsSupported Then
        Console.WriteLine("Windows XP SP2 or Server 2003 is required to use the HttpListener class.")
        Return
    End If

    ' URI prefixes are required,
    ' for example "http://contoso.com:8080/index/"
    If prefixes Is Nothing OrElse prefixes.Length = 0 Then Throw New ArgumentException("prefixes")
    Dim listener As HttpListener = New HttpListener()

    For Each s As String In prefixes
        listener.Prefixes.Add(s)
    Next

    listener.Start()
    ' Specify Negotiate as the authentication scheme.
    listener.AuthenticationSchemes = AuthenticationSchemes.Negotiate
    Console.WriteLine("Listening...")
    ' GetContext blocks while waiting for a request.
    Dim context As HttpListenerContext = listener.GetContext()
    Dim request As HttpListenerRequest = context.Request
    ' Obtain a response object.
    Dim response As HttpListenerResponse = context.Response
    Dim clientInformationString As String = ClientInformation(context)
    Dim buffer As Byte() = System.Text.Encoding.UTF8.GetBytes("<HTML><BODY> " & clientInformationString & "</BODY></HTML>")
    ' Get a response stream and write the response to it.
    response.ContentLength64 = buffer.Length
    Dim output As System.IO.Stream = response.OutputStream
    output.Write(buffer, 0, buffer.Length)
    output.Close()
    listener.Stop()
End Sub

Remarks

The ContentLength64 property must be set explicitly before writing to the returned Stream object.

Note

Closing the request does not close the stream returned by this property. When you no longer need the stream, you should close it by calling the Close method.

Applies to

See also