HttpListenerResponse.AppendCookie(Cookie) Method

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.

Adds the specified Cookie to the collection of cookies for this response.

public:
 void AppendCookie(System::Net::Cookie ^ cookie);

public void AppendCookie (System.Net.Cookie cookie);

member this.AppendCookie : System.Net.Cookie -> unit

Public Sub AppendCookie (cookie As Cookie)

Parameters

cookie: Cookie

The Cookie to add to the collection to be sent with this response.

Exceptions

ArgumentNullException

cookie is null.

Examples

The following code example demonstrates adding a cookie to a response

// 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 Shared Function NextCustomerID() As String
    ' A real-world application would do something more robust
    ' to ensure uniqueness.
    Return DateTime.Now.ToString()
End Function

Public Shared Sub SimpleListenerCookieExample(ByVal prefixes As String())
    ' Create a listener
    Dim listener As HttpListener = New HttpListener()

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

    listener.IgnoreWriteExceptions = True
    listener.Start()
    Console.WriteLine("Listening...")
    ' Note: The GetContext method blocks while waiting for a request. 
    Dim context As HttpListenerContext = listener.GetContext()
    Dim request As HttpListenerRequest = context.Request
    Dim customerID As String = Nothing

    ' Did the request come with a cookie?
    Dim cookie As Cookie = request.Cookies("ID")

    If cookie IsNot Nothing Then
        customerID = cookie.Value
    End If

    If customerID IsNot Nothing Then
        Console.WriteLine("Found the cookie!")
    End If

    ' Get the response object.
    Dim response As HttpListenerResponse = context.Response
    ' If they didn't provide a cookie containing their ID, give them one.
    If customerID Is Nothing Then
        customerID = NextCustomerID()
        Dim cook As Cookie = New Cookie("ID", customerID)
        response.AppendCookie(cook)
    End If
    ' Construct a response.
    Dim responseString As String = "<HTML><BODY> Hello " & customerID & "!</BODY></HTML>"
    Dim buffer As Byte() = System.Text.Encoding.UTF8.GetBytes(responseString)
    ' Get the 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)
    ' You must close the output stream.
    output.Close()
    response.Close()
    listener.Stop()
End Sub

Remarks

Calling this method is equivalent to calling the Add method on the collection returned by the Cookies property.

If the specified cookie does not exist in the Cookies property's collection, cookie is added. If the cookie exists in the collection, cookie replaces it.

Applies to

Dela via