This documentation is archived and is not being maintained.

SessionIDManager.SaveSessionID Method

Saves a newly created session identifier to the HTTP response.

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

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

Parameters

context
Type: System.Web.HttpContext
The current HttpContext object that references server objects used to process HTTP requests (for example, the Request and Response properties).
id
Type: System.String
The session identifier.
redirected
Type: System.Boolean%
When this method returns, contains a Boolean value that is true if the response is redirected to the current URL with the session identifier added to the URL; otherwise, false.
cookieAdded
Type: System.Boolean%
When this method returns, contains a Boolean value that is true if a cookie has been added to the HTTP response; otherwise, false.

Implements

ISessionIDManager.SaveSessionID(HttpContext, String, Boolean, Boolean)

ExceptionCondition
HttpException

The response has already been sent.

-or-

The session ID passed to this method failed validation.

This method is not intended to be called from application code.

The SaveSessionID method is called by the SessionStateModule object during the AcquireRequestState event. The SaveSessionID method stores the session identifier in either the URL (when cookieless session state is used) or in a non-expiring session cookie.

By default, the SessionIDManager places a unique session identifier into a non-expiring session cookie and sets the cookieAdded parameter to true.

For a cookieless session state, the SessionIDManager object inserts a unique session identifier into the current URL, redirects the browser to the new URL that includes the session identifier, and then sets the redirected parameter to true.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: