PersonalizationAdministration::ResetUserState Method (String^, String^)

 

Resets per-user state in the underlying data store for the specified combination of user name and path.

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

public:
static bool ResetUserState(
	String^ path,
	String^ username
)

Parameters

path
Type: System::String^

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

username
Type: System::String^

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

Return Value

Type: System::Boolean

The number of rows that were reset.

Exception Condition
ArgumentNullException

path or username is null.

ArgumentException

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

- or -

username contains commas.

- 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.

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

.NET Framework
Available since 2.0
Return to top
Show: