HttpCookie 類別

定義

提供型別安全 (Type-Safe) 方式來建立並操作個別 HTTP Cookie。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
繼承
HttpCookie

範例

下列程式碼範例示範如何檢查物件中名為的 cookie DateCookieExample HttpRequestThe following code example demonstrates how to check for a cookie named DateCookieExample in the HttpRequest object. 如果找不到 cookie,則會建立並將它新增至 HttpResponse 物件。If the cookie is not found, it is created and added to the HttpResponse object. Cookie 已設定為在10分鐘後到期。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>
<%@ Page Language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

    Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)
        Dim sb As New StringBuilder()
        ' Get cookie from current request.
        Dim cookie As HttpCookie
        cookie = Request.Cookies.Get("DateCookieExample")
        
        ' Check if cookie exists in the current request
        If (cookie Is Nothing) Then
            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/>")
        End If
        Label1.Text = sb.ToString()

    End Sub
</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>

備註

HttpCookie類別會取得並設定個別 cookie 的屬性。The HttpCookie class gets and sets properties of individual cookies. HttpCookieCollection類別提供儲存、抓取和管理多個 cookie 的方法。The HttpCookieCollection class provides methods to store, retrieve, and manage multiple cookies.

ASP.NET 包含兩個內建的 cookie 集合。ASP.NET includes two intrinsic cookie collections. 透過物件的集合存取的集合, Cookies HttpRequest 包含由用戶端傳送至標頭中伺服器的 cookie CookieThe collection accessed through the Cookies collection of the HttpRequest object contains cookies transmitted by the client to the server in the Cookie header. 透過物件的集合存取的集合會 Cookies HttpResponse 包含在伺服器上建立的新 cookie,並在 Set-Cookie HTTP 回應標頭中傳輸至用戶端。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.

建構函式

HttpCookie(String)

建立並命名新 Cookie。Creates and names a new cookie.

HttpCookie(String, String)

建立、命名和指派數值給新 Cookie。Creates, names, and assigns a value to a new cookie.

屬性

Domain

取得或設定與 Cookie 關聯的網域。Gets or sets the domain to associate the cookie with.

Expires

取得或設定 Cookie 的到期日和時間。Gets or sets the expiration date and time for the cookie.

HasKeys

取得值,指出 Cookie 是否有子索引鍵 (Subkey)。Gets a value indicating whether a cookie has subkeys.

HttpOnly

取得或設定數值,指定 Cookie 是否由用戶端指令碼存取。Gets or sets a value that specifies whether a cookie is accessible by client-side script.

Item[String]

取得 Values 屬性的捷徑。Gets a shortcut to the Values property. 提供這個屬性來與 ASP 先前版本相容。This property is provided for compatibility with previous versions of Active Server Pages (ASP).

Name

取得或設定 Cookie 的名稱。Gets or sets the name of a cookie.

Path

取得或設定與目前 Cookie 一起傳輸的虛擬路徑。Gets or sets the virtual path to transmit with the current cookie.

SameSite

取得或設定 Cookie 的 SameSite 屬性值。Gets or sets the value for the SameSite attribute of the cookie.

Secure

取得或設定值,指出是否要使用 SSL (亦即,只能透過 HTTPS) 來傳輸 Cookie。Gets or sets a value indicating whether to transmit the cookie using Secure Sockets Layer (SSL)--that is, over HTTPS only.

Shareable

判斷 cookie 是否可以參與輸出快取。Determines whether the cookie is allowed to participate in output caching.

Value

取得或設定個別 Cookie 值。Gets or sets an individual cookie value.

Values

取得包含於單一 Cookie 物件內索引鍵/值組的集合。Gets a collection of key/value pairs that are contained within a single cookie object.

方法

Equals(Object)

判斷指定的物件是否等於目前的物件。Determines whether the specified object is equal to the current object.

(繼承來源 Object)
GetHashCode()

做為預設雜湊函式。Serves as the default hash function.

(繼承來源 Object)
GetType()

取得目前執行個體的 TypeGets the Type of the current instance.

(繼承來源 Object)
MemberwiseClone()

建立目前 Object 的淺層複製。Creates a shallow copy of the current Object.

(繼承來源 Object)
ToString()

傳回代表目前物件的字串。Returns a string that represents the current object.

(繼承來源 Object)
TryParse(String, HttpCookie)

將 Cookie 的指定字串表示,轉換為其相等的 HttpCookie,並傳回一個值指出轉換是否成功。Converts the specified string representation of a cookie into its HttpCookie equivalent and returns a value that indicates whether the conversion succeeded.

適用於

另請參閱