HttpCookie Class
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
Provides a type-safe way to create and manipulate individual HTTP cookies.
Namespace: System.Web
Assembly: System.Web (in System.Web.dll)
The HttpCookie type exposes the following members.
| Name | Description | |
|---|---|---|
|
HttpCookie(String) | Creates and names a new cookie. |
|
|
HttpCookie(String, String) | Creates, names, and assigns a value to a new cookie. |
| Name | Description | |
|---|---|---|
|
Domain | Gets or sets the domain to associate the cookie with. |
|
|
Expires | Gets or sets the expiration date and time for the cookie. |
|
|
HasKeys | Gets a value indicating whether a cookie has subkeys. |
|
|
HttpOnly | Gets or sets a value that specifies whether a cookie is accessible by client-side script. |
|
|
Item | Gets a shortcut to the HttpCookie.Values property. This property is provided for compatibility with previous versions of Active Server Pages (ASP). |
|
|
Name | Gets or sets the name of a cookie. |
|
|
Path | Gets or sets the virtual path to transmit with the current cookie. |
|
|
Secure | Gets or sets a value indicating whether to transmit the cookie using Secure Sockets Layer (SSL)--that is, over HTTPS only. |
|
|
Shareable | Determines whether the cookie is allowed to participate in output caching. |
|
|
Value | Gets or sets an individual cookie value. |
|
|
Values | Gets a collection of key/value pairs that are contained within a single cookie object. |
| Name | Description | |
|---|---|---|
|
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
The HttpCookie class gets and sets properties of individual cookies. The HttpCookieCollection class provides methods to store, retrieve, and manage multiple cookies.
ASP.NET includes two intrinsic cookie collections. The collection accessed through the Cookies collection of the HttpRequest object contains cookies transmitted by the client to the server in the Cookie header. The collection accessed through the Cookies collection of the HttpResponse object contains new cookies created on the server and transmitted to the client in the Set-Cookie HTTP response header.
The following code example demonstrates how to check for a cookie named DateCookieExample in the HttpRequest object. If the cookie is not found, it is created and added to the HttpResponse object. The cookie is set to expire in 10 minutes.
<%@ Page Language="C#" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> protected void Page_Load(object sender, EventArgs e) { StringBuilder sb = new StringBuilder(); // Get cookie from the current request. HttpCookie cookie = Request.Cookies.Get("DateCookieExample"); // Check if cookie exists in the current request. if (cookie == null) { sb.Append("Cookie was not received from the client. "); sb.Append("Creating cookie to add to the response. <br/>"); // Create cookie. cookie = new HttpCookie("DateCookieExample"); // Set value of cookie to current date time. cookie.Value = DateTime.Now.ToString(); // Set cookie to expire in 10 minutes. cookie.Expires = DateTime.Now.AddMinutes(10d); // Insert the cookie in the current HttpResponse. Response.Cookies.Add(cookie); } else { sb.Append("Cookie retrieved from client. <br/>"); sb.Append("Cookie Name: " + cookie.Name + "<br/>"); sb.Append("Cookie Value: " + cookie.Value + "<br/>"); sb.Append("Cookie Expiration Date: " + cookie.Expires.ToString() + "<br/>"); } Label1.Text = sb.ToString(); } </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>HttpCookie Example</title> </head> <body> <form id="form1" runat="server"> <div> <asp:Label id="Label1" runat="server"></asp:Label> </div> </form> </body> </html>
Windows 8 Release Preview, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
