CreatingCookieEventArgs.IsPersistent プロパティ

定義

認証クッキーを現在のセッションの終了後も残すかどうかを示す値を取得します。

public:
 property bool IsPersistent { bool get(); };
public bool IsPersistent { get; }
member this.IsPersistent : bool
Public ReadOnly Property IsPersistent As Boolean

プロパティ値

クッキーを現在のセッションの終了後も残す場合は true。それ以外の場合は false

次の例は、 イベントのイベント ハンドラーを CreatingCookie 示しています。 ハンドラーは、認証 Cookie をカスタマイズするために、 CreatingCookieEventArgs オブジェクトからユーザー値を取得します。 IsPersistentオブジェクトの FormsAuthenticationTicket プロパティは、 プロパティの値にIsPersistent設定されます。

void AuthenticationService_CreatingCookie(object sender, 
    System.Web.ApplicationServices.CreatingCookieEventArgs e)
{
    FormsAuthenticationTicket ticket = new
          FormsAuthenticationTicket
            (1,
             e.UserName,
             DateTime.Now,
             DateTime.Now.AddMinutes(30),
             e.IsPersistent,
             e.CustomCredential,
             FormsAuthentication.FormsCookiePath);

    string encryptedTicket =
         FormsAuthentication.Encrypt(ticket);

    HttpCookie cookie = new HttpCookie
         (FormsAuthentication.FormsCookieName,
          encryptedTicket);
    cookie.Expires = DateTime.Now.AddMinutes(30);

    HttpContext.Current.Response.Cookies.Add(cookie);
    e.CookieIsSet = true;
}
Sub AuthenticationService_CreatingCookie(ByVal sender As Object, _
                 ByVal e As System.Web.ApplicationServices.CreatingCookieEventArgs)
    Dim ticket As FormsAuthenticationTicket = New _
       FormsAuthenticationTicket _
        (1, _
         e.Username, _
         DateTime.Now, _
         DateTime.Now.AddMinutes(30), _
         e.IsPersistent, _
         e.CustomCredential, _
         FormsAuthentication.FormsCookiePath)
        
    Dim encryptedTicket As String = FormsAuthentication.Encrypt(ticket)
    
    Dim cookie As HttpCookie = New _
        HttpCookie(FormsAuthentication.FormsCookieName, encryptedTicket)
    cookie.Expires = DateTime.Now.AddMinutes(30)
    
    HttpContext.Current.Response.Cookies.Add(cookie)
    e.CookieIsSet = True
End Sub

注釈

オブジェクトを FormsAuthenticationTicket 作成するときに、 プロパティを IsPersistent 使用して、認証 Cookie が現在のセッションを超えて保持されるかどうかを指定できます。

適用対象