This documentation is archived and is not being maintained.

PersonalizationAdministration::ResetUserState Method (array<String>)

Resets all per-user state in the underlying data store for the specified paths.

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

public:
static int ResetUserState(
	array<String^>^ usernames
)

Parameters

usernames
Type: array<System::String>

An array of user names whose per-user data should be reset.

Return Value

Type: System::Int32
The number of rows that were reset.

ExceptionCondition
ArgumentNullException

usernames is nullptr.

ArgumentException

usernames is a zero-length array.

- or -

A member of usernames is either nullptr, contains commas, or is an empty string ("") after trimming.

- 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 all per-user state in the underlying data store associated with the users contained in the usernames parameter, and returns a count of the number of rows that were reset.

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

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: