PersonalizationAdministration.ResetInactiveUserState Method

  • Reference

Definition

Namespace:
System.Web.UI.WebControls.WebParts
Assembly:
System.Web.dll

Resets per-user personalization state information by deleting the associated rows in the underlying data store.

Overloads

ResetInactiveUserState(DateTime)

Resets all per-user personalization state information in the underlying data store, based on the specified parameter.
ResetInactiveUserState(String, DateTime)

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

ResetInactiveUserState(DateTime)

Resets all per-user personalization state information in the underlying data store, based on the specified parameter.

public:
 static int ResetInactiveUserState(DateTime userInactiveSinceDate);
public static int ResetInactiveUserState (DateTime userInactiveSinceDate);
static member ResetInactiveUserState : DateTime -> int
Public Shared Function ResetInactiveUserState (userInactiveSinceDate As DateTime) As Integer

Parameters

userInactiveSinceDate
DateTime

The last date a user's personalization information was accessed.

Returns

Int32

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

Exceptions

ArgumentException

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.

Remarks

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

If UserInactiveSinceDate is set to MaxValue, this method resets all per-user data in the underlying data store.

See also

Applies to

ResetInactiveUserState(String, DateTime)

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

public:
 static int ResetInactiveUserState(System::String ^ path, DateTime userInactiveSinceDate);
public static int ResetInactiveUserState (string path, DateTime userInactiveSinceDate);
static member ResetInactiveUserState : string * DateTime -> int
Public Shared Function ResetInactiveUserState (path As String, userInactiveSinceDate As DateTime) As Integer

Parameters

path
String

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

userInactiveSinceDate
DateTime

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

Returns

Int32

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

Exceptions

ArgumentNullException

path is null.

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.

Remarks

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.

See also

Applies to