HttpCookie Classe

Definição

Fornece uma maneira fortemente tipada de criar e manipular cookies HTTP individuais.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
Herança
HttpCookie

Exemplos

O exemplo de código a seguir demonstra como verificar um cookie chamado DateCookieExample HttpRequest no objeto.The following code example demonstrates how to check for a cookie named DateCookieExample in the HttpRequest object. Se o cookie não for encontrado, ele será criado e adicionado ao HttpResponse objeto.If the cookie is not found, it is created and added to the HttpResponse object. O cookie é definido para expirar em 10 minutos.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>

Comentários

A HttpCookie classe obtém e define as propriedades de cookies individuais.The HttpCookie class gets and sets properties of individual cookies. A HttpCookieCollection classe fornece métodos para armazenar, recuperar e gerenciar vários cookies.The HttpCookieCollection class provides methods to store, retrieve, and manage multiple cookies.

ASP.NET inclui duas coleções de cookies intrínsecas.ASP.NET includes two intrinsic cookie collections. A coleção acessada Cookies por meio da HttpRequest coleção do objeto contém cookies transmitidos pelo cliente Cookie para o servidor no cabeçalho.The collection accessed through the Cookies collection of the HttpRequest object contains cookies transmitted by the client to the server in the Cookie header. A coleção acessada Cookies por meio da HttpResponse coleção do objeto contém novos cookies criados no servidor e transmitidos Set-Cookie para o cliente no cabeçalho de resposta 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.

Construtores

HttpCookie(String)

Cria e nomeia um novo cookie.Creates and names a new cookie.

HttpCookie(String, String)

Cria, nomeia e atribui um valor a um novo cookie.Creates, names, and assigns a value to a new cookie.

Propriedades

Domain

Obtém ou define o domínio a ser associado ao cookie.Gets or sets the domain to associate the cookie with.

Expires

Obtém ou define a data e hora de expiração do cookie.Gets or sets the expiration date and time for the cookie.

HasKeys

Obtém um valor que indica se o um cookie tem subchaves.Gets a value indicating whether a cookie has subkeys.

HttpOnly

Obtém ou define um valor que especifica se um cookie é acessível pelo script do lado do cliente.Gets or sets a value that specifies whether a cookie is accessible by client-side script.

Item[String]

Obtém um atalho para a propriedade Values.Gets a shortcut to the Values property. Esta propriedade é fornecida para compatibilidade com versões anteriores de ASP (Active Server Pages).This property is provided for compatibility with previous versions of Active Server Pages (ASP).

Name

Obtém ou define o nome de um cookie.Gets or sets the name of a cookie.

Path

Obtém ou define o caminho virtual para transmitir com o cookie atual.Gets or sets the virtual path to transmit with the current cookie.

SameSite

Obtém ou define o valor do atributo SameSite do cookie.Gets or sets the value for the SameSite attribute of the cookie.

Secure

Obtém ou define um valor indicando se deve transmitir o cookie usando o protocolo SSL, isto é, apenas via HTTPS.Gets or sets a value indicating whether to transmit the cookie using Secure Sockets Layer (SSL)--that is, over HTTPS only.

Shareable

Determina se o cookie tem permissão para participar do cache de saída.Determines whether the cookie is allowed to participate in output caching.

Value

Obtém ou define um valor de cookie individual.Gets or sets an individual cookie value.

Values

Obtém uma coleção de pares chave-valor que estão contidos em um único objeto de cookie.Gets a collection of key/value pairs that are contained within a single cookie object.

Métodos

Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.Determines whether the specified object is equal to the current object.

(Herdado de Object)
GetHashCode()

Serve como a função de hash padrão.Serves as the default hash function.

(Herdado de Object)
GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Herdado de Object)
MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Herdado de Object)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Herdado de Object)
TryParse(String, HttpCookie)

Converte a representação de cadeia de caracteres especificada de um cookie em seu HttpCookie equivalente e retorna um valor que indica se a conversão foi bem-sucedida.Converts the specified string representation of a cookie into its HttpCookie equivalent and returns a value that indicates whether the conversion succeeded.

Aplica-se a

Veja também