ISessionIDManager.SaveSessionID メソッドとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

ISessionIDManager.SaveSessionID メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

新規作成されたセッション識別子を HTTP 応答に保存します。

名前空間: System.Web.SessionState
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Sub SaveSessionID ( _
    context As HttpContext, _
    id As String, _
    <OutAttribute> ByRef redirected As
 Boolean, _
    <OutAttribute> ByRef cookieAdded As
 Boolean _
)

Visual Basic (使用法)

Dim instance As ISessionIDManager
Dim context As HttpContext
Dim id As String
Dim redirected As Boolean
Dim cookieAdded As Boolean

instance.SaveSessionID(context, id, redirected, cookieAdded)

void SaveSessionID (
    HttpContext context,
    string id,
    out bool redirected,
    out bool cookieAdded
)

C++

void SaveSessionID (
    HttpContext^ context, 
    String^ id, 
    [OutAttribute] bool% redirected, 
    [OutAttribute] bool% cookieAdded
)

void SaveSessionID (
    HttpContext context, 
    String id, 
    /** @attribute OutAttribute() */ /** @ref */ boolean redirected, 
    /** @attribute OutAttribute() */ /** @ref */ boolean cookieAdded
)

JScript

JScript では、値型の引数は参照渡しされません。

パラメータ

context: Request プロパティ、Response プロパティなどの HTTP 要求を処理するためのサーバーオブジェクトを参照する現在の HttpContext オブジェクト。

id: セッション識別子。

redirected: このメソッドが返されるときに、セッション識別子が URL に追加された状態で応答が現在の URL にリダイレクトされた場合は true のブール値を格納します。それ以外の場合は false を格納します。

cookieAdded: このメソッドが返されるときに、Cookie が HTTP 応答に追加された場合は true のブール値を格納します。それ以外の場合は false を格納します。

解説

HttpApplication.AcquireRequestState イベントの発生中に、SessionStateModule オブジェクトによって SaveSessionID メソッドが呼び出されます。SaveSessionID メソッドは、URL (Cookie なしのセッション状態を使用する場合) または無期限のセッション Cookie にセッション識別子を保存します。

CreateSessionID の実装が返す値に HTTP 応答または要求で無効な文字が含まれる場合、UrlEncode メソッドを使用して、SaveSessionID メソッドの実装のセッション識別子値をエンコードし、UrlDecode メソッドを使用して、GetSessionID メソッドの実装のセッション識別子値をデコードする必要があります。

使用例

GetSessionID メソッドの部分的な実装のコード例を次に示します。カスタムのセッション ID マネージャが Cookie なしのセッション識別子をサポートする場合、ISAPI フィルタなどのセッション識別子を URL に含めてやり取りするソリューションを実装する必要があります。

Visual Basic

Public Sub SaveSessionID(context As
 HttpContext, _
                         id As String, _
                         ByRef redirected As
 Boolean, _
                         ByRef cookieAdded As
 Boolean) _
  Implements ISessionIDManager.SaveSessionID

  redirected = False
  cookieAdded = False

  If pConfig.Cookieless = HttpCookieMode.UseUri Then

    ' Add the SessionID to the URI. Set the redirected variable as appropriate.

    redirected = True
    Return
  Else
    context.Response.Cookies.Add(New HttpCookie(pConfig.CookieName,
 id))
    cookieAdded = True
  End If
End Sub

public void SaveSessionID(HttpContext context,
 string id, out bool redirected, out bool
 cookieAdded)
{
  redirected = false;
  cookieAdded = false;

  if (pConfig.Cookieless == HttpCookieMode.UseUri)
  {
    // Add the SessionID to the URI. Set the redirected variable as
 appropriate.

    redirected = true;
    return;
  }
  else
  {
    context.Response.Cookies.Add(new HttpCookie(pConfig.CookieName,
 id));
    cookieAdded = true;
  }
}