This documentation is archived and is not being maintained.

SqlPersonalizationProvider::ResetUserState Method

Deletes user 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
) override

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

Return Value

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

ExceptionCondition
ArgumentException

path is an empty string.

- or -

The path is greater than 256 characters in length.

This method's parameters have the following restrictions:

  • The path parameter cannot contain wildcard characters.

  • 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 specified in the userInactiveSinceDate parameter will be deleted. The exact comparison would be to delete records where the LastActivityDate property is less than or equal to the userInactiveSinceDate parameter.

  • 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 after trimming.

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