Cookie Class

Definition

public ref class Cookie sealed

public sealed class Cookie

[System.Serializable]
public sealed class Cookie

type Cookie = class

[<System.Serializable>]
type Cookie = class

Public NotInheritable Class Cookie

Inheritance

Object

Cookie

Attributes

SerializableAttribute

Examples

The following example sends a request to a URL and displays the cookies returned in the response.

using System.Net;
using System;
namespace Examples.System.Net.Cookies
{
 // This example is run at the command line.
 // Specify one argument: the name of the host to
 // send the request to.
 // If the request is sucessful, the example displays the contents of the cookies
 // returned by the host.

 public class CookieExample
 {
 public static void Main(string[] args)
 {
 if (args == null || args.Length != 1)
 {
 Console.WriteLine("Specify the URL to receive the request.");
 Environment.Exit(1);
 }
 var request = (HttpWebRequest)WebRequest.Create(args[0]);
 request.CookieContainer = new CookieContainer();

 using (var response = (HttpWebResponse) request.GetResponse())
 {
 // Print the properties of each cookie.
 foreach (Cookie cook in response.Cookies)
 {
 Console.WriteLine("Cookie:");
 Console.WriteLine($"{cook.Name} = {cook.Value}");
 Console.WriteLine($"Domain: {cook.Domain}");
 Console.WriteLine($"Path: {cook.Path}");
 Console.WriteLine($"Port: {cook.Port}");
 Console.WriteLine($"Secure: {cook.Secure}");

 Console.WriteLine($"When issued: {cook.TimeStamp}");
 Console.WriteLine($"Expires: {cook.Expires} (expired? {cook.Expired})");
 Console.WriteLine($"Don't save: {cook.Discard}");
 Console.WriteLine($"Comment: {cook.Comment}");
 Console.WriteLine($"Uri for comments: {cook.CommentUri}");
 Console.WriteLine($"Version: RFC {(cook.Version == 1 ? 2109 : 2965)}");

 // Show the string representation of the cookie.
 Console.WriteLine($"String: {cook}");
 }
 }
 }
 }
}

// Output from this example will be vary depending on the host name specified,
// but will be similar to the following.
/*
Cookie:
CustomerID = 13xyz
Domain: .contoso.com
Path: /
Port:
Secure: False
When issued: 1/14/2003 3:20:57 PM
Expires: 1/17/2013 11:14:07 AM (expired? False)
Don't save: False
Comment:
Uri for comments:
Version: RFC 2965
String: CustomerID = 13xyz
*/

Imports System.Net

' This example is run at the command line.
' Specify one argument: the name of the host to 
' receive the request.
' If the request is sucessful, the example displays the contents of the cookies
' returned by the host.

Public Class CookieExample
 
 Public Shared Sub Main(args() As String)
 If args Is Nothing OrElse args.Length <> 1 Then
 Console.WriteLine("Specify the URL to receive the request.")
 Environment.Exit(1)
 End If
 Dim request As HttpWebRequest = WebRequest.Create(args(0))
 request.CookieContainer = New CookieContainer()
 
 Using response As HttpWebResponse = request.GetResponse()
 ' Print the properties of each cookie.
 For Each cook As Cookie In response.Cookies
 Console.WriteLine("Cookie:")
 Console.WriteLine($"{cook.Name} = {cook.Value}")
 Console.WriteLine($"Domain: {cook.Domain}")
 Console.WriteLine($"Path: {cook.Path}")
 Console.WriteLine($"Port: {cook.Port}")
 Console.WriteLine($"Secure: {cook.Secure}")
 
 Console.WriteLine($"When issued: {cook.TimeStamp}")
 Console.WriteLine($"Expires: {cook.Expires} (expired? {cook.Expired})")
 Console.WriteLine($"Don't save: {cook.Discard}")
 Console.WriteLine($"Comment: {cook.Comment}")
 Console.WriteLine($"Uri for comments: {cook.CommentUri}")
 Console.WriteLine($"Version: RFC {If(cook.Version = 1, 2109, 2965)}")
 
 ' Show the string representation of the cookie.
 Console.WriteLine($"String: {cook}")
 Next
 End Using
 End Sub
End Class



' Output from this example will be vary depending on the host name specified,
' but will be similar to the following.
'
'Cookie:
'CustomerID = 13xyz
'Domain: .contoso.com
'Path: /
'Port:
'Secure: False
'When issued: 1/14/2003 3:20:57 PM
'Expires: 1/17/2013 11:14:07 AM (expired? False)
'Don't save: False
'Comment: 
'Uri for comments:
'Version: RFC 2965
'String: CustomerID = 13xyz
'

Remarks

The Cookie class is used by a client application to retrieve information about cookies that are received with HTTP responses. The following cookie formats are supported during parsing of the HTTP response headers: the original Netscape specification, RFC 2109, and RFC 2965.

For a list of initial property values for an instance of Cookie, see the various Cookie constructors.

See also

• CookieCollection
• CookieContainer
• CookieException