PersonalizationAdministration::ResetUserState Method (String^, array<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
)

Parameters

path
Type: System::String^

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

usernames
Type: array<System::String^>^

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

Return Value

Type: System::Int32

The number of rows that were reset.

Exception Condition
ArgumentNullException

path or usernames is null.

ArgumentException

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

- or -

A member of usernames is null, 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.

.NET Framework
Available since 2.0
Return to top
Show: