This documentation is archived and is not being maintained.

PersonalizationProvider::ResetUserState Method

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

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

public:
virtual int ResetUserState(
	String^ path, 
	DateTime userInactiveSinceDate
) abstract

Parameters

path
Type: System::String
The path of the personalization data to be deleted. This value can be nullptr but cannot be an empty string ("").
userInactiveSinceDate
Type: System::DateTime
The date indicating the last time a Web site user changed personalization data.

Return Value

Type: System::Int32
The number of rows deleted from the underlying data store.

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-nullptr, 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 nullptr.

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

  • The UserInactiveSinceDate property cannot be nullptr.

.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: