This documentation is archived and is not being maintained.

PersonalizationAdministration::ResetInactiveUserState Method (String, DateTime)

Resets all per-user state information in the underlying data store for inactive users, based on the specified parameters.

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

public:
static int ResetInactiveUserState(
	String^ path, 
	DateTime userInactiveSinceDate
)

Parameters

path
Type: System::String
The path to the page associated with the personalization state information to be reset.
userInactiveSinceDate
Type: System::DateTime
The last active date to be used in resetting user state personalization items.

Return Value

Type: System::Int32
The number of rows in the underlying data store that were reset.

ExceptionCondition
ArgumentNullException

path is nullptr.

ArgumentException

path 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 returned a negative number for the count.

This method resets all per-user state in the underlying data store associated with the specified path, where the user's LastActivityDate property value is less than or equal to the UserInactiveSinceDate property value.

For data stores that require more than one row of data to store personalization state for a page, or for a user and page combination, the count of reset rows might differ from the count of personalization state. If the underlying provider exposes data from a transaction-aware data store, this method performs its operations in a single transaction.

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

If UserInactiveSinceDate is MaxValue, this method effectively resets all per-user data in the underlying data store for the specified path.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: