SessionStateUtility::AddHttpSessionStateToContext Method (HttpContext^, IHttpSessionState^)
Applies the session data to the context for the current request.
Assembly: System.Web (in System.Web.dll)
public: static void AddHttpSessionStateToContext( HttpContext^ context, IHttpSessionState^ container )
Parameters
- context
-
Type:
System.Web::HttpContext^
The HttpContext object to which to add the HttpSessionState object.
- container
-
Type:
System.Web.SessionState::IHttpSessionState^
The IHttpSessionState implementation instance to add to the specified HTTP context.
| Exception | Condition |
|---|---|
| HttpException | An HttpSessionState object for the current session has already been added to the specified context. |
The AddHttpSessionStateToContext method is used by a session-state module to apply session data to the current request. This occurs during the AcquireRequestState event at the beginning of a request. Session data for the current request is either retrieved for an existing session or created for a new session. The session data is then encapsulated in an IHttpSessionState implementation instance, which is passed to the AddHttpSessionStateToContext method along with the current HttpContext. The supplied session data is then made available to application code through the Session property of the current context.
The following code example shows the handler for the AcquireRequestState event in a custom session-state module. The custom module retrieves existing session information or creates new session information and uses the AddHttpSessionStateToContext method to add it to the HttpContext of the current request. This code example is part of a larger example provided for the SessionStateUtility class.
Available since 2.0