PersonalizationAdministration.ResetInactiveUserState Method (String, DateTime)

Note: This method is new in the .NET Framework version 2.0.

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
)
public static int ResetInactiveUserState (
	String path, 
	DateTime userInactiveSinceDate
)
public static function ResetInactiveUserState (
	path : String, 
	userInactiveSinceDate : DateTime
) : int

Parameters

path

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

userInactiveSinceDate

The last active date to be used in resetting user state personalization items.

Return Value

The number of rows in the underlying data store that were reset.

Exception typeCondition

ArgumentNullException

path is a null reference (Nothing in Visual Basic).

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.

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show: