Export (0) Print
Expand All

HttpListenerResponse.Close Method (Byte[], Boolean)

Returns the specified byte array to the client and releases the resources held by this HttpListenerResponse instance.

Namespace:  System.Net
Assembly:  System (in System.dll)

public function Close(
	responseEntity : byte[], 
	willBlock : boolean
)

Parameters

responseEntity
Type: System.Byte[]

A Byte array that contains the response to send to the client.

willBlock
Type: System.Boolean

true to block execution while flushing the stream to the client; otherwise, false.

ExceptionCondition
ArgumentNullException

responseEntity is a null reference (Nothing in Visual Basic).

ObjectDisposedException

This object is closed.

If you are sending body data with the response, you can use this method to send it as a Byte array instead of writing the body data to the OutputStream property and calling the Close method.

This method closes the response stream and the HttpListenerRequest associated with the response.

The following code example demonstrates calling this method.

// This example requires the System and System.Net namespaces. 
public static void SimpleListenerExample2(string[] prefixes)
{
    // URI prefixes are required, 
    // for example "http://contoso.com:8080/index/".
    if (prefixes == null || prefixes.Length == 0)
      throw new ArgumentException("prefixes");

    // Create a listener.
    HttpListener listener = new HttpListener();
    // Add the prefixes. 
    foreach (string s in prefixes)
    {
        listener.Prefixes.Add(s);
    }
    listener.Start();
    Console.WriteLine("Listening...");
    // Note: The GetContext method 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 responseString = "<HTML><BODY> Hello world!</BODY></HTML>";
    byte[] buffer = System.Text.Encoding.UTF8.GetBytes(responseString);
    // Get a response stream and write the response to it.
    response.ContentLength64 = buffer.Length;
    // Demonstrate using the close overload that takes an  
    // entity body. 
    // Specify true to block while data is transmitted.
    response.Close(buffer, true);
    listener.Stop();
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft