SqlPersonalizationProvider.ResetUserState Method (String, DateTime)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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 override int ResetUserState(
	string path,
	DateTime userInactiveSinceDate
)

Parameters

path
Type: System.String

The path of the personalization data to be deleted. This value can be null 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.

Exception Condition
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-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 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 null.

  • The path parameter cannot be an empty string after trimming.

  • The UserInactiveSinceDate property cannot be null.

.NET Framework
Available since 2.0
Return to top
Show: