SessionStateStoreProviderBase.RemoveItem Method

Definition

Deletes item data from the session data store.

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

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.

item
SessionStateStoreData

The SessionStateStoreData that represents the item to delete from the data store.

Examples

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

Remarks

The SessionStateModule object calls the RemoveItem method at the end of a request, during the ReleaseRequestState event, to delete the data for a session item from the session data store if the Abandon method has been called. Only session data for the current application that matches the supplied session id and lockId values is deleted. For more information about locking and details about the lock identifier, see "Locking Session-Store Data" in the SessionStateStoreProviderBase class overview.

Applies to

See also