Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

HttpListenerResponse.Cookies Property

Gets or sets the collection of cookies returned with the response.

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

public CookieCollection Cookies { get; set; }
/** @property */
public CookieCollection get_Cookies ()

/** @property */
public void set_Cookies (CookieCollection value)

public function get Cookies () : CookieCollection

public function set Cookies (value : CookieCollection)

Not applicable.

Property Value

A CookieCollection that contains cookies to accompany the response. The collection is empty if no cookies have been added to the response.

A cookie is name/value text data from a Web server that is stored on the local (client) computer. The following cookie formats are supported: Netscape, RFC 2109, and RFC 2965. The Netscape cookie specification is available at http://wp.netscape.com/newsref/std/cookie_spec.html; the RFC documents are available at http://www.rfc-editor.org.

The following code example checks a request for a cookie, and returns a new cookie with the response if the request did not have one.

// This example requires the System and System.Net namespaces.

public static string NextCustomerID()
{
    // A real-world application would do something more robust
    // to ensure uniqueness.
    return DateTime.Now.ToString();
}
public static void SimpleListenerCookieExample(string[] prefixes)
{
    // Create a listener.
    HttpListener listener = new HttpListener();
    // Add the prefixes.
    foreach (string s in prefixes)
    {
        listener.Prefixes.Add(s);
    }
    listener.IgnoreWriteExceptions = true;
    listener.Start();
    Console.WriteLine("Listening...");
    // Note: The GetContext method blocks while waiting for a request. 
    HttpListenerContext context = listener.GetContext();
    HttpListenerRequest request = context.Request;
    string customerID = null;

    // Did the request come with a cookie?
    Cookie cookie = request.Cookies["ID"];
    if (cookie != null)
    {
         customerID=cookie.Value;
    }
    if (customerID !=null)
    {
          Console.WriteLine("Found the cookie!");
    }
    // Get the response object.
    HttpListenerResponse response = context.Response;
    // If they didn't provide a cookie containing their ID, give them one.
    if (customerID == null)
    {
        customerID = NextCustomerID();
        Cookie cook = new Cookie("ID", customerID );
        response.AppendCookie (cook);
    }
    // Construct a response.
    string responseString = "<HTML><BODY> Hello " + customerID + "!</BODY></HTML>";
    byte[] buffer = System.Text.Encoding.UTF8.GetBytes(responseString);
    // Get the response stream and write the response to it.
    response.ContentLength64 = buffer.Length;
    System.IO.Stream output = response.OutputStream;
    output.Write(buffer,0,buffer.Length);
    // You must close the output stream.
    output.Close();
    // Closing the response sends the response to the client.
    response.Close();
    listener.Stop();
}

// This example requires the System and System.Net namespaces.
public static String NextCustomerID()
{
    // A real-world application would do something more robust
    // to ensure uniqueness.
    return DateTime.get_Now().ToString();
} //NextCustomerID

public static void SimpleListenerCookieExample(String prefixes[])
{
    // Create a listener.
    HttpListener listener = new HttpListener();
    // Add the prefixes.
    for (int iCtr = 0; iCtr < prefixes.get_Length(); iCtr++) {
        String s = prefixes[iCtr];
        listener.get_Prefixes().Add(s);
    }
    listener.set_IgnoreWriteExceptions(true);
    listener.Start();
    Console.WriteLine("Listening...");
    // Note: The GetContext method blocks while waiting for a request. 
    HttpListenerContext context = listener.GetContext();
    HttpListenerRequest request = context.get_Request();
    String customerID = null;
    // Did the request come with a cookie?
    Cookie cookie = request.get_Cookies().get_Item("ID");
    if (cookie != null) {
        customerID = cookie.get_Value();
    }
    if (customerID != null) {
        Console.WriteLine("Found the cookie!");
    }
    // Get the response object.
    HttpListenerResponse response = context.get_Response();
    // If they didn't provide a cookie containing their ID, give them one.
    if (customerID == null) {
        customerID = NextCustomerID();
        Cookie cook = new Cookie("ID", customerID);
        response.AppendCookie(cook);
    }
    // Construct a response.
    String responseString = "<HTML><BODY> Hello " + customerID 
           + "!</BODY></HTML>";
    ubyte buffer[] = System.Text.Encoding.get_UTF8().
          GetBytes(responseString);
    // Get the response stream and write the response to it.
    response.set_ContentLength64(buffer.get_Length());
    System.IO.Stream output = response.get_OutputStream();
    output.Write(buffer, 0, buffer.get_Length());
    // You must close the output stream.
    output.Close();
    // Closing the response sends the response to the client.
    response.Close();
    listener.Stop();
} //SimpleListenerCookieExample

Windows 98, Windows Server 2003, Windows XP Media Center Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.