PersonalizationAdministration.ResetUserState Method (String[])

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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(
	string[] usernames
)

Parameters

usernames
Type: 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.

Exception Condition
ArgumentNullException

usernames is null.

ArgumentException

usernames is a zero-length array.

- or -

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

.NET Framework
Available since 2.0
Return to top
Show: