PersonalizationAdministration.ResetUserState Method (String, String[])

Resets per-user state in the underlying data store for the page and users specified.

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

public:
static int ResetUserState (
	String^ path, 
	array<String^>^ usernames
)
public static int ResetUserState (
	String path, 
	String[] usernames
)
public static function ResetUserState (
	path : String, 
	usernames : String[]
) : int
Not applicable.

Parameters

path

The path to the page associated with the personalization state information to be reset.

usernames

The user names associated with the personalization data to be reset.

Return Value

The number of rows that were reset.

Exception typeCondition

ArgumentNullException

path or usernames is a null reference (Nothing in Visual Basic).

ArgumentException

path is an empty string ("") after trimming.

- or -

A member of usernames is a null reference (Nothing in Visual Basic), an empty string after trimming, or contains commas.

- or -

usernames is a zero-length array.

- or -

The provider for a personalization provider defined in configuration is not of the correct type.

- or -

The length of the string of any parameter is greater than 256 characters.

ConfigurationErrorsException

A configuration exception occurred while attempting to create and initialize an instance of one of the configured personalization providers.

- or -

The default personalization provider defined in configuration could not be found.

HttpException

The default provider indicated that the number of deleted rows was a negative number.

This method resets per-user state in the underlying data store associated with each user contained in the usernames parameter for the page specified by path.

It is not an error to attempt to reset nonexistent user state.

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: