PersonalizationStateInfoCollection.Remove Method

Removes a PersonalizationStateInfo-derived object from the collection.

Namespace: System.Web.UI.WebControls.WebParts
Assembly: System.Web (in system.web.dll)

public:
void Remove (
	String^ path, 
	String^ username
)
public void Remove (
	String path, 
	String username
)
public function Remove (
	path : String, 
	username : String
)
Not applicable.

Parameters

path

The relative application path of the personalization state object to be removed.

username

The user name of the UserPersonalizationStateInfo-derived object to be removed.

Exception typeCondition

NotSupportedException

The collection was marked as read-only.

ArgumentNullException

path is null.

- or -

both parameters are null.

This method removes a PersonalizationStateInfo-derived instance from the collection. Any elements after the removed instance are moved up to occupy the vacant position. Internally, the count of the collection is decremented by one. Any enumerators currently active against the collection are invalidated.

If only path is provided, then the SharedPersonalizationStateInfo instance for that path is removed. If both path and username are provided, then the UserPersonalizationStateInfo instance for the combination of path and username is removed.

NoteNote:

You can try to remove a non-existing item from the collection; this action will not raise an exception.

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: