This documentation is archived and is not being maintained.

Cookie Class

Provides a set of properties and methods that are used to manage cookies. This class cannot be inherited.

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

<SerializableAttribute> _
Public NotInheritable Class Cookie
Dim instance As Cookie

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.

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

Imports System.Net
Imports System

' 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.")
        End If 
        Dim request As HttpWebRequest = CType(WebRequest.Create(args(0)), HttpWebRequest)
        request.CookieContainer = New CookieContainer()

        Dim response As HttpWebResponse = CType(request.GetResponse(), HttpWebResponse)

        ' Print the properties of each cookie. 
        Dim cook As Cookie
        For Each cook In  response.Cookies
            Console.WriteLine("{0} = {1}", cook.Name, cook.Value)
            Console.WriteLine("Domain: {0}", cook.Domain)
            Console.WriteLine("Path: {0}", cook.Path)
            Console.WriteLine("Port: {0}", cook.Port)
            Console.WriteLine("Secure: {0}", cook.Secure)

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

            ' Show the string representation of the cookie.
            Console.WriteLine("String: {0}", cook.ToString())
        Next cook
    End Sub 'Main
End Class 'CookieExample 

' Output from this example will be vary depending on the host name specified, 
' but will be similar to the following. 

'CustomerID = 13xyz 
'Path: / 
'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 
'Uri for comments: 
'Version: RFC 2965 
'String: CustomerID = 13xyz 
#using <mscorlib.dll>
#using <System.dll>
using namespace System;
using namespace System::Net;

// 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.

int main()
    String* args[] = Environment::GetCommandLineArgs();

    if (args == 0 || args->Length != 2)
        Console::WriteLine(S"Specify the URL to receive the request.");
    HttpWebRequest* request = dynamic_cast<HttpWebRequest*>(WebRequest::Create(args[1]));
    request->CookieContainer = new CookieContainer();

    HttpWebResponse* response = dynamic_cast<HttpWebResponse*> (request->GetResponse());
    response->Cookies = request->CookieContainer->GetCookies(request->RequestUri);

    // Print the properties of each cookie.
    System::Collections::IEnumerator* myEnum = response->Cookies->GetEnumerator();
    while (myEnum->MoveNext())
        Cookie* cook = __try_cast<Cookie*>(myEnum->Current);
        Console::WriteLine(S"{0} = {1}", cook->Name, cook->Value);
        Console::WriteLine(S"Domain: {0}", cook->Domain);
        Console::WriteLine(S"Path: {0}", cook->Path);
        Console::WriteLine(S"Port: {0}", cook->Port);
        Console::WriteLine(S"Secure: {0}", __box(cook->Secure));

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

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

// Output from this example will be vary depending on the host name specified,
// but will be similar to the following.
CustomerID = 13xyz
Path: /
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
Uri for comments:
Version: RFC 2965
String: CustomerID = 13xyz

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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, 1.1, 1.0