CreatingCookieEventArgs クラス

定義

CreatingCookie イベントのデータを提供します。

public ref class CreatingCookieEventArgs : EventArgs
public class CreatingCookieEventArgs : EventArgs
type CreatingCookieEventArgs = class
    inherit EventArgs
Public Class CreatingCookieEventArgs
Inherits EventArgs
継承
CreatingCookieEventArgs

次の例は、 イベントのイベント ハンドラーを CreatingCookie 示しています。 ハンドラーは、 オブジェクトからユーザー値を CreatingCookieEventArgs 取得して、認証 Cookie をカスタマイズします。 ハンドラーは、 プロパティの値を CustomCredential 認証チケットに保存し、 プロパティを CookieIsSettrue 設定して、認証 Cookie が作成されたことを示します。

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

注釈

クラスは CreatingCookieEventArgs 、任意 CreatingCookie のイベント ハンドラーに値を提供します。 このクラスのプロパティを使用すると、カスタム認証 Cookie を作成するときにユーザー資格情報を取得できます。

クラスは AuthenticationService 、ユーザーの資格情報が CreatingCookie 認証された後に、認証 Cookie を設定するときに イベントを発生させます。 クラスは AuthenticationService オブジェクトを CreatingCookieEventArgs 構築し、それを任意 CreatingCookie のイベント ハンドラーに渡します。

ユーザー資格情報は、 プロパティと CustomCredential プロパティをUserNamePassword使用して取得します。 プロパティには CustomCredential 、認証に必要な任意のカスタム値 (識別番号など) を含めることができます。 プロパティは IsPersistent 、認証 Cookie を現在のセッションを過ぎても保持する必要があるかどうかを示します。 認証 Cookie を CookieIsSet 作成する場合は、 プロパティを に true 設定して、クラスが AuthenticationService Cookie を作成しないようにします。

プロパティ

CookieIsSet

認証クッキーが作成されたかどうかを示す値を取得または設定します。

CustomCredential

ユーザーが入力する追加の認証値を取得します。

IsPersistent

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

Password

ユーザーのパスワードを取得します。

UserName

ユーザーの名前を取得します。

メソッド

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。

(継承元 Object)
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)

適用対象

こちらもご覧ください