SessionStateUtility.GetHttpSessionStateFromContext Method (HttpContext)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Retrieves session data from the context for the current request.

Namespace:   System.Web.SessionState
Assembly:  System.Web (in System.Web.dll)

public static IHttpSessionState GetHttpSessionStateFromContext(
	HttpContext context
)

Parameters

context
Type: System.Web.HttpContext

The HttpContext from which to retrieve session data.

Return Value

Type: System.Web.SessionState.IHttpSessionState

An IHttpSessionState implementation instance populated with session data from the current request.

The GetHttpSessionStateFromContext method can be used by a session-state module to retrieve session data from the current request. This occurs during the ReleaseRequestState event at the end of a request. The returned session data can then be written to the session data store. If the session has been abandoned, the session data can be removed from the data store and HttpContext, and the Session_OnEnd event can be executed.

Notes to Implementers:

You can use the RemoveHttpSessionStateFromContext method to remove session data from the internal store, and the RaiseSessionEnd method to raise the Session_OnEnd event.

The following code example shows the handler for the ReleaseRequestState event in a custom session-state module. The module retrieves session data from the HttpContext for the current request using the GetHttpSessionStateFromContext method. This code example is part of a larger example provided for the SessionStateUtility class.

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

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

    // 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);

            sessionID = pSessionIDManager.GetSessionID(context);
            pSessionItems.Remove(sessionID);
        }
        finally
        {
            pHashtableLock.ReleaseWriterLock();
        }

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

    SessionStateUtility.RemoveHttpSessionStateFromContext(context);
}

.NET Framework
Available since 2.0
Return to top
Show: