Language

HttpCookie Class

Definition

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

public ref class HttpCookie sealed
public sealed class HttpCookie
type HttpCookie = class
Public NotInheritable Class HttpCookie
Inheritance
HttpCookie

Examples

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#" %>







    HttpCookie Example


    
<%@ Page Language="VB" %>







    HttpCookie Example


    

Remarks

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.

Constructors

Name Description
HttpCookie(String, String)

Creates, names, and assigns a value to a new cookie.

HttpCookie(String)

Creates and names a new cookie.

Properties

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[String]

Gets a shortcut to the 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.

SameSite

Gets or sets the value for the SameSite attribute of the 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.

Methods

Name Description
Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(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)
TryParse(String, HttpCookie)

Converts the specified string representation of a cookie into its HttpCookie equivalent and returns a value that indicates whether the conversion succeeded.

Applies to

See also