SessionStateStoreProviderBase.CreateUninitializedItem(HttpContext, String, Int32) Method

Definition

Adds a new session-state item to the data store.

public:
 abstract void CreateUninitializedItem(System::Web::HttpContext ^ context, System::String ^ id, int timeout);
public abstract void CreateUninitializedItem (System.Web.HttpContext context, string id, int timeout);
abstract member CreateUninitializedItem : System.Web.HttpContext * string * int -> unit
Public MustOverride Sub CreateUninitializedItem (context As HttpContext, id As String, timeout As Integer)

Parameters

context
HttpContext

The HttpContext for the current request.

id
String

The SessionID for the current request.

timeout
Int32

The session Timeout for the current request.

Examples

For an example of a session-state store provider implementation, see Implementing a Session-State Store Provider.

Remarks

The CreateUninitializedItem method is used with sessions when the cookieless and regenerateExpiredSessionId attributes are both true. Having the regenerateExpiredSessionId attribute set to true causes the SessionStateModule object to generate a new SessionID value when an expired SessionID value is encountered.

The process of generating a new SessionID value requires redirecting the browser to a URL that contains the newly generated SessionID value. The CreateUninitializedItem method is called during the initial request that contains an expired SessionID value. After the SessionStateModule object acquires a new SessionID value to replace the expired value, it calls the CreateUninitializedItem method to add an uninitialized entry to the session-state data store. The browser is then redirected to the URL containing the newly generated SessionID value. The existence of the uninitialized entry in the session data store ensures that the redirected request that includes the newly generated SessionID value is not mistaken for a request for an expired session and is, instead, treated as a new session.

The uninitialized entry in the session data store is associated with the newly generated SessionID value and contains only default values, including an expiration date and time and a value that corresponds to the actionFlags parameter of the GetItem and GetItemExclusive methods. The uninitialized entry in the session-state store should include an actionFlags value equal to the InitializeItem enumeration value. This value is passed to the SessionStateModule object by the GetItem and GetItemExclusive methods, and informs the SessionStateModule object that the current session is a new but uninitialized session. The SessionStateModule object will then initialize the new session and raise the Session_OnStart event.

For more information about cookieless sessions, see the IsCookieless property.

Applies to

See also