This documentation is archived and is not being maintained.

IHttpSessionState.Abandon Method

Ends the current session.

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

void Abandon()

The Abandon method is used to clear out session data and raise the Session_OnEnd event defined in the Global.asax file for the ASP.NET application.

The following code example implements the Abandon method of the IHttpSessionState interface. The code example duplicates the behavior of the HttpSessionStateContainer class in that it adds an IsAbandoned property that is set to true when the Abandon method is called. The IsAbandoned property is checked by the session-state module during the ReleaseRequestState event to determine whether the session has been abandoned, and the session-state module clears out session data and executes the Session_OnEnd event.


//
// Abandon marks the session as abandoned. The IsAbandoned property is used by the
// session state module to perform the abandon work during the ReleaseRequestState event.
//
public void Abandon()
{
  pAbandon = true;
}

public bool IsAbandoned
{
  get { return pAbandon; }
}


.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: