Edit

Share via

PersonalizationProvider.ResetUserState(String, DateTime) Method

Definition

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

When overridden in a derived class, deletes Web Parts personalization data from the underlying data store based on the specified parameters.

public:
 abstract int ResetUserState(System::String ^ path, DateTime userInactiveSinceDate);
public abstract int ResetUserState(string path, DateTime userInactiveSinceDate);
abstract member ResetUserState : string * DateTime -> int
Public MustOverride Function ResetUserState (path As String, userInactiveSinceDate As DateTime) As Integer

Parameters

path
String

The path of the personalization data to be deleted. This value can be null but cannot be an empty string ("").

userInactiveSinceDate
DateTime

The date indicating the last time a Web site user changed personalization data.

Returns

Int32

The number of rows deleted from the underlying data store.

Remarks

This method is the abstract definition of an administrative method for deleting personalization data. Note that this method affects only user personalization data, and not shared data.

Derived implementations should follow the logic described below:

  • The path parameter cannot contain wildcard characters.

  • If the provider exposes data from a transaction-aware data store, this method should perform its operations in a single atomic transaction.

  • If the path parameter is non-null, then only per-user personalization records associated with path will be deleted.

  • Only per-user personalization records associated with users that are considered inactive since the date indicated in the userInactiveSinceDate parameter will be deleted. Specifically, records where LastActivityDate is less than or equal to UserInactiveSinceDate are deleted.

  • If both parameters are provided, then records that match both constraints are deleted.

  • The path parameter can be null.

  • The path parameter cannot be an empty string. It should be trimmed prior to performing this check.

  • The UserInactiveSinceDate property cannot be null.

Applies to