CreatingCookieEventArgs クラス

定義

CreatingCookie イベントのデータを提供します。Provides data for the CreatingCookie event.

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

次の例は、CreatingCookie イベントのイベントハンドラーを示しています。The following example shows an event handler for the CreatingCookie event. ハンドラーは、CreatingCookieEventArgs オブジェクトからユーザー値を取得して、認証 cookie をカスタマイズします。The handler retrieves user values from the CreatingCookieEventArgs object to customize the authentication cookie. ハンドラーは認証チケットの CustomCredential プロパティから値を保存し、CookieIsSet プロパティを true に設定して、認証 cookie が作成されたことを示します。The handler saves the value from the CustomCredential property in the authentication ticket and sets the CookieIsSet property to true to indicate that the authentication cookie has been created.

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 のイベントハンドラーに値を提供します。The CreatingCookieEventArgs class supplies values to any CreatingCookie event handler. このクラスのプロパティを使用して、カスタム認証クッキーを作成するときにユーザー資格情報を取得できます。By using the properties of this class, you can retrieve user credentials when you create a custom authentication cookie.

AuthenticationService クラスは、ユーザーの資格情報が認証された後に、認証 cookie を設定するときに CreatingCookie イベントを発生させます。The AuthenticationService class raises the CreatingCookie event when it sets the authentication cookie, after the user credentials have been authenticated. AuthenticationService クラスは CreatingCookieEventArgs オブジェクトを構築し、それを任意の CreatingCookie イベントハンドラーに渡します。The AuthenticationService class constructs a CreatingCookieEventArgs object and passes it to any CreatingCookie event handler.

ユーザーの資格情報を取得するには、UserNamePassword、および CustomCredential のプロパティを使用します。You retrieve the user credentials through the UserNamePassword, and CustomCredential properties. CustomCredential プロパティには、id 番号など、認証のために必要な任意のカスタム値を含めることができます。The CustomCredential property can contain any custom values that you need in order to authenticate, such as an identification number. IsPersistent プロパティは、認証クッキーを現在のセッションの後に保持する必要があるかどうかを示します。The IsPersistent property indicates whether the authentication cookie should be retained past the current session. AuthenticationService クラスが cookie を作成しないように認証 cookie を作成する場合は、CookieIsSet プロパティを true に設定します。Set the CookieIsSet property to true if you create the authentication cookie, so that the AuthenticationService class does not create the cookie.

プロパティ

CookieIsSet

認証クッキーが作成されたかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the authentication cookie has been created.

CustomCredential

ユーザーが入力する追加の認証値を取得します。Gets additional authentication values that are provided by the user.

IsPersistent

認証クッキーを現在のセッションの終了後も残すかどうかを示す値を取得します。Gets a value that indicates whether the authentication cookie should be retained beyond the current session.

Password

ユーザーのパスワードを取得します。Gets the password for the user.

UserName

ユーザーの名前を取得します。Gets the name for the user.

メソッド

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判定します。Determines whether the specified object is equal to the current object.

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ToString()

現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)

適用対象

こちらもご覧ください