ISessionStateItemCollection.Dirty Property

Definition

Namespace:

System.Web.SessionState

Assembly:

System.Web.dll

Gets or sets a value indicating whether the collection has been marked as changed.

public:
 property bool Dirty { bool get(); void set(bool value); };

public bool Dirty { get; set; }

member this.Dirty : bool with get, set

Public Property Dirty As Boolean

Property Value

Boolean

true if the SessionStateItemCollection contents have been changed; otherwise, false.

Examples

The following code example shows an implementation of the Dirty property. For an example of a complete implementation of the ISessionStateItemCollection interface, see the example provided for the ISessionStateItemCollection interface overview.

private bool pDirty = false;

public bool Dirty
{
  get { return pDirty; }
  set { pDirty = value; }
}

Private pDirty As Boolean = False

Public Property Dirty As Boolean Implements ISessionStateItemCollection.Dirty    
  Get
    Return pDirty
  End Get
  Set
    pDirty = value
  End Set
End Property

Remarks

The Dirty property is used by the SessionStateModule to determine whether the values in an ISessionStateItemCollection implementation have been modified.

In implementing the ISessionStateItemCollection interface, you should initialize the Dirty property as false and set the Dirty property to true in the implementations of the Remove, RemoveAt, or Clear methods.

See also

• ASP.NET Session State Overview