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

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

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

SessionStateUtility.GetHttpSessionStateFromContext メソッド

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

現在の要求のコンテキストからセッションデータを取得します。

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

Visual Basic (宣言)

Public Shared Function GetHttpSessionStateFromContext
 ( _
    context As HttpContext _
) As IHttpSessionState

Visual Basic (使用法)

Dim context As HttpContext
Dim returnValue As IHttpSessionState

returnValue = SessionStateUtility.GetHttpSessionStateFromContext(context)

public static IHttpSessionState GetHttpSessionStateFromContext
 (
    HttpContext context
)

C++

public:
static IHttpSessionState^ GetHttpSessionStateFromContext (
    HttpContext^ context
)

public static IHttpSessionState GetHttpSessionStateFromContext
 (
    HttpContext context
)

JScript

public static function GetHttpSessionStateFromContext
 (
    context : HttpContext
) : IHttpSessionState

パラメータ

context: セッションデータの取得元の HttpContext。

戻り値
現在の要求のセッションデータを含む IHttpSessionState の実装のインスタンス。

解説

GetHttpSessionStateFromContext メソッドは、セッション状態モジュールがセッションデータを現在の要求から取得するために使用します。これは、要求の最後の ReleaseRequestState イベントで行います。返されたセッションデータは、セッションデータストアに書き込むことができます。セッションが破棄されると、セッションデータをデータストアから削除できるようになり、HttpContext と Session_OnEnd イベントを実行できます。

実装時の注意 RemoveHttpSessionStateFromContext メソッドを使用して内部ストアからセッションデータを削除し、RaiseSessionEnd メソッドを使用して Session_OnEnd イベントを生成します。

使用例

カスタムのセッション状態モジュールの ReleaseRequestState イベントのハンドラのコード例を次に示します。このモジュールは、GetHttpSessionStateFromContext メソッドを使用して現在の要求の HttpContext からセッションデータを取得します。このコード例は、SessionStateUtility クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

'
' Event handler for HttpApplication.ReleaseRequestState
'

Private Sub OnReleaseRequestState(source As
 Object, args As EventArgs)
  Dim app     As HttpApplication = CType(source,
 HttpApplication)
  Dim context As HttpContext     = app.Context

  ' Read the session state from the context
  Dim stateProvider As HttpSessionStateContainer
 =  _
    CType(SessionStateUtility.GetHttpSessionStateFromContext(context), HttpSessionStateContainer)

  ' If Session.Abandon() was called, remove the session data from the
 local Hashtable
  ' and execute the Session_OnEnd event from the Global.asax file.

  If stateProvider.IsAbandoned Then      
    Try
      pHashtableLock.AcquireWriterLock(Int32.MaxValue)
      pSessionItems.Remove(pSessionID)
    Finally
      pHashtableLock.ReleaseWriterLock()
    End Try

    SessionStateUtility.RaiseSessionEnd(stateProvider, Me, EventArgs.Empty)
  End If

  SessionStateUtility.RemoveHttpSessionStateFromContext(context)
End Sub

//
// Event handler for HttpApplication.ReleaseRequestState
//

private void OnReleaseRequestState(object source,
 EventArgs args)
{
  HttpApplication app     = (HttpApplication)source;
  HttpContext     context = app.Context;

  // Read the session state from the context
  HttpSessionStateContainer stateProvider = 
    (HttpSessionStateContainer)(SessionStateUtility.GetHttpSessionStateFromContext(context));

  // If Session.Abandon() was called, remove the session data from the
 local Hashtable
  // and execute the Session_OnEnd event from the Global.asax file.

  if (stateProvider.IsAbandoned)
  {
    try
    {
      pHashtableLock.AcquireWriterLock(Int32.MaxValue);
      pSessionItems.Remove(pSessionID);
    }
    finally
    {
      pHashtableLock.ReleaseWriterLock();
    }

    SessionStateUtility.RaiseSessionEnd(stateProvider, this, EventArgs.Empty);
  }

  SessionStateUtility.RemoveHttpSessionStateFromContext(context);
}