Export (0) Print
Expand All

HttpCookie Class

Provides a type-safe way to create and manipulate individual HTTP cookies.

System.Object
  System.Web.HttpCookie

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

public sealed class HttpCookie

The HttpCookie type exposes the following members.

  NameDescription
Public methodHttpCookie(String)Creates and names a new cookie.
Public methodHttpCookie(String, String)Creates, names, and assigns a value to a new cookie.
Top

  NameDescription
Public propertyDomainGets or sets the domain to associate the cookie with.
Public propertyExpiresGets or sets the expiration date and time for the cookie.
Public propertyHasKeysGets a value indicating whether a cookie has subkeys.
Public propertyHttpOnlyGets or sets a value that specifies whether a cookie is accessible by client-side script.
Public propertyItemGets a shortcut to the HttpCookie.Values property. This property is provided for compatibility with previous versions of Active Server Pages (ASP).
Public propertyNameGets or sets the name of a cookie.
Public propertyPathGets or sets the virtual path to transmit with the current cookie.
Public propertySecureGets or sets a value indicating whether to transmit the cookie using Secure Sockets Layer (SSL)--that is, over HTTPS only.
Public propertyShareableDetermines whether the cookie is allowed to participate in output caching.
Public propertyValueGets or sets an individual cookie value.
Public propertyValuesGets a collection of key/value pairs that are contained within a single cookie object.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

TopicLocation
How to: Write a CookieBuilding ASP .NET Web Applications
How to: Write a CookieBuilding ASP .NET Web Applications

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>

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), 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.

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