HttpCookie Classe

Définition

Espace de noms:
System.Web
Assembly:
System.Web.dll

Fournit un moyen sécurisé de créer et de manipuler des cookies HTTP individuels.

public ref class HttpCookie sealed
public sealed class HttpCookie
type HttpCookie = class
Public NotInheritable Class HttpCookie
Héritage
Object
HttpCookie

Exemples

L’exemple de code suivant montre comment rechercher un cookie nommé DateCookieExample dans l’objet HttpRequest . Si le cookie est introuvable, il est créé et ajouté à l’objet HttpResponse . Le cookie est défini pour expirer en 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>

Remarques

La HttpCookie classe obtient et définit les propriétés des cookies individuels. La HttpCookieCollection classe fournit des méthodes pour stocker, récupérer et gérer plusieurs cookies.

ASP.NET comprend deux collections de cookies intrinsèques. La collection accessible via la Cookies collection de l’objet HttpRequest contient des cookies transmis par le client au serveur dans l’en-tête Cookie . La collection accessible via la Cookies collection de l’objet HttpResponse contient de nouveaux cookies créés sur le serveur et transmis au client dans l’en-tête Set-Cookie de réponse HTTP.

Constructeurs

Nom Description
HttpCookie(String, String)

Crée, nomme et affecte une valeur à un nouveau cookie.
HttpCookie(String)

Crée et nomme un cookie.

Propriétés

Nom Description
Domain

Obtient ou définit le domaine auquel associer le cookie.
Expires

Obtient ou définit la date et l’heure d’expiration du cookie.
HasKeys

Obtient une valeur indiquant si un cookie a des sous-clés.
HttpOnly

Obtient ou définit une valeur qui spécifie si un cookie est accessible par un script côté client.
Item[String]

Obtient un raccourci vers la Values propriété. Cette propriété est fournie pour la compatibilité avec les versions précédentes des pages Active Server (ASP).
Name

Obtient ou définit le nom d’un cookie.
Path

Obtient ou définit le chemin d’accès virtuel à transmettre avec le cookie actuel.
SameSite

Obtient ou définit la valeur de l’attribut SameSite du cookie.
Secure

Obtient ou définit une valeur indiquant s’il faut transmettre le cookie à l’aide du protocole SSL (Secure Sockets Layer), autrement dit, via HTTPS uniquement.
Shareable

Détermine si le cookie est autorisé à participer à la mise en cache de sortie.
Value

Obtient ou définit une valeur de cookie individuelle.
Values

Obtient une collection de paires clé/valeur contenues dans un objet cookie unique.

Méthodes

Nom Description
Equals(Object)

Détermine si l’objet spécifié est égal à l’objet actuel.

(Hérité de Object)
GetHashCode()

Sert de fonction de hachage par défaut.

(Hérité de Object)
GetType()

Obtient la Type de l’instance actuelle.

(Hérité de Object)
MemberwiseClone()

Crée une copie superficielle du Objectactuel.

(Hérité de Object)
ToString()

Retourne une chaîne qui représente l’objet actuel.

(Hérité de Object)
TryParse(String, HttpCookie)

Convertit la représentation sous forme de chaîne spécifiée d’un cookie en son HttpCookie équivalent et retourne une valeur qui indique si la conversion a réussi.

S’applique à

Voir aussi