PersonalizationProvider.ResetUserState Method

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

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

Parameters

path

The path of the personalization data to be deleted. This value can be a null reference (Nothing in Visual Basic) but cannot be an empty string ("").

userInactiveSinceDate

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

Return Value

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-a null reference (Nothing in Visual Basic), 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 a null reference (Nothing in Visual Basic).

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

  • The UserInactiveSinceDate property cannot be a null reference (Nothing in Visual Basic).

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: