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:
virtual void SaveSessionID (
	HttpContext^ context, 
	String^ id, 
	[OutAttribute] bool% redirected, 
	[OutAttribute] bool% cookieAdded
) sealed
public final void SaveSessionID (
	HttpContext context, 
	String id, 
	/** @attribute OutAttribute() */ /** @ref */ boolean redirected, 
	/** @attribute OutAttribute() */ /** @ref */ boolean cookieAdded
)
Not applicable.

Parameters

context

The current HttpContext object that references server objects used to process HTTP requests (for example, the Request and Response properties).

id

The session identifier.

redirected

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

When this method returns, contains a Boolean value that is true if a cookie has been added to the HTTP response; otherwise, false.

Exception typeCondition

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.

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: