HttpCookie HttpCookie HttpCookie HttpCookie Class

Определение

Предоставляет типобезопасный способ создания и обработки отдельных НТТР-файлов 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
Наследование
HttpCookieHttpCookieHttpCookieHttpCookie

Примеры

В следующем примере кода показано, как проверить наличие файла cookie с DateCookieExample именем HttpRequest в объекте.The 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, переданные клиентом Cookie на сервер в заголовке.The 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) HttpCookie(String) HttpCookie(String) HttpCookie(String)

Создает новый файл Cookie и присваивает ему имя.Creates and names a new cookie.

HttpCookie(String, String) HttpCookie(String, String) HttpCookie(String, String) HttpCookie(String, String)

Создает новый файл Cookie и присваивает ему имя и значение.Creates, names, and assigns a value to a new cookie.

Свойства

Domain Domain Domain Domain

Получает или задает домен, связанный с файлом Cookie.Gets or sets the domain to associate the cookie with.

Expires Expires Expires Expires

Получает или задает срок действия и время для текущего файла Cookie.Gets or sets the expiration date and time for the cookie.

HasKeys HasKeys HasKeys HasKeys

Получает значение, определяющее наличие подразделов в файле Cookie.Gets a value indicating whether a cookie has subkeys.

HttpOnly HttpOnly HttpOnly HttpOnly

Получает или задает значение, указывающее имеет ли клиентский скрипт доступ к файлу Cookie.Gets or sets a value that specifies whether a cookie is accessible by client-side script.

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

Получает или задает имя файла Cookie.Gets or sets the name of a cookie.

Path Path Path Path

Получает или задает виртуальный путь для передачи вместе с текущим файлом Cookie.Gets or sets the virtual path to transmit with the current cookie.

SameSite SameSite SameSite SameSite

Получает или устанавливает значение атрибута SameSite файла cookie.Gets or sets the value for the SameSite attribute of the cookie.

Secure Secure Secure Secure

Получает или задает значение, определяющее, выполнять ли передачу файлов Cookie по протоколу SSL (т.е. только по протоколу HTTPS).Gets or sets a value indicating whether to transmit the cookie using Secure Sockets Layer (SSL)--that is, over HTTPS only.

Shareable Shareable Shareable Shareable

Определяет, разрешен ли файл cookie для участия в кэшировании выходных данных.Determines whether the cookie is allowed to participate in output caching.

Value Value Value Value

Получает или задает индивидуальное значение файла Cookie.Gets or sets an individual cookie value.

Values Values Values Values

Получает коллекцию значений в паре "ключ-значение", содержащуюся в одном файле Cookie.Gets a collection of key/value pairs that are contained within a single cookie object.

Методы

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)
TryParse(String, HttpCookie) TryParse(String, HttpCookie) TryParse(String, HttpCookie) 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.

Применяется к

Дополнительно