Edit

Share via


SessionStateStoreProviderBase.ReleaseItemExclusive Method

Definition

Releases a lock on an item in the session data store.

public:
 abstract void ReleaseItemExclusive(System::Web::HttpContext ^ context, System::String ^ id, System::Object ^ lockId);
public abstract void ReleaseItemExclusive (System.Web.HttpContext context, string id, object lockId);
abstract member ReleaseItemExclusive : System.Web.HttpContext * string * obj -> unit
Public MustOverride Sub ReleaseItemExclusive (context As HttpContext, id As String, lockId As Object)

Parameters

context
HttpContext

The HttpContext for the current request.

id
String

The session identifier for the current request.

lockId
Object

The lock identifier for the current request.

Examples

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

Remarks

The SessionStateModule object calls the ReleaseItemExclusive method to update the expiration date and release a lock on an item in the session data store. It is called at the end of a request, during the ReleaseRequestState event, if session values are unchanged. If session values have been modified, the SessionStateModule object instead calls the SetAndReleaseItemExclusive method.

The SessionStateModule object also calls the ReleaseItemExclusive method when a lock on an item in the session data store has exceeded the ExecutionTimeout value. For more information about locking and details about the lock identifier, see "Locking Session-Store Data" in the SessionStateStoreProviderBase class overview.

The ReleaseItemExclusive method only removes the lock from an item in the session data store for the current application that matches the supplied session id and lockId values. If the lockId does not match the one in the data store, the ReleaseItemExclusive method does nothing.

Applies to

See also