Export (0) Print
Expand All

Cookie.Comment Property

Gets or sets a comment that the server can add to a Cookie.

[Visual Basic]
Public Property Comment As String
[C#]
public string Comment {get; set;}
[C++]
public: __property String* get_Comment();
public: __property void set_Comment(String*);
[JScript]
public function get Comment() : String;
public function set Comment(String);

Property Value

An optional comment to document intended usage for this Cookie.

Remarks

The client can inspect this optional comment for information added by the server. For example, the server could include information about issues such as the privacy policy or intended usage.

Example

[Visual Basic, C#] The following example displays the properties of cookies returned in a response. For the complete example, see the Cookie class topic.

[Visual Basic] 
Dim request As HttpWebRequest = CType(WebRequest.Create(args(0)), HttpWebRequest)
request.CookieContainer = New CookieContainer()

Dim response As HttpWebResponse = CType(request.GetResponse(), HttpWebResponse)
response.Cookies = request.CookieContainer.GetCookies(request.RequestUri)


' Print the properties of each cookie.
Dim cook As Cookie
For Each cook In  response.Cookies
    Console.WriteLine("Cookie:")
    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

[C#] 
HttpWebRequest request = (HttpWebRequest)WebRequest.Create(args[0]);
request.CookieContainer = new CookieContainer();
        
HttpWebResponse response = (HttpWebResponse) request.GetResponse();
response.Cookies = request.CookieContainer.GetCookies(request.RequestUri);


// Print the properties of each cookie.
foreach (Cookie cook in response.Cookies)
{
    Console.WriteLine("Cookie:");
    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}" , cook.Version == 1 ? "2109" : "2965");

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

[C++, JScript] No example is available for C++ or JScript. To view a Visual Basic or C# example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

Cookie Class | Cookie Members | System.Net Namespace | CookieCollection | CookieContainer | CookieException

Show:
© 2014 Microsoft