ResetUserState Method (String)

PersonalizationAdministration.ResetUserState Method (String)

 

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

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

public static int ResetUserState(
	string path
)

Parameters

path
Type: System.String

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

Return Value

Type: System.Int32

The number of rows that were reset.

Exception Condition
ArgumentNullException

path is null.

ArgumentException

path is an empty string ("").

- 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 returns the 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:
© 2016 Microsoft