SqlPersonalizationProvider.ResetState Method

Reference

Definition

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

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Deletes personalization state information from the underlying data store, based on the specified parameters.

public:
 override int ResetState(System::Web::UI::WebControls::WebParts::PersonalizationScope scope, cli::array <System::String ^> ^ paths, cli::array <System::String ^> ^ usernames);

public override int ResetState (System.Web.UI.WebControls.WebParts.PersonalizationScope scope, string[] paths, string[] usernames);

override this.ResetState : System.Web.UI.WebControls.WebParts.PersonalizationScope * string[] * string[] -> int

Public Overrides Function ResetState (scope As PersonalizationScope, paths As String(), usernames As String()) As Integer

Parameters

scope: PersonalizationScope

A PersonalizationScope indicating the personalization information to be queried. This value cannot be null.

paths: String[]

The paths for personalization information in the Shared scope to be deleted.

usernames: String[]

The user names for personalization information in the User scope to be deleted.

Returns

Int32

The number of rows deleted.

Exceptions

ArgumentException

Either the paths or the usernames parameter is an empty array.

-or-

The paths and usernames parameters contained within the respective arrays do not meet the validation rules.

ArgumentOutOfRangeException

The scope specified is not a member of the PersonalizationScope enumeration.

Remarks

No wildcard characters are supported by this method.

Only the following combinations of parameters are allowed:

The scope parameter is set, and all other parameters are set to null. This combination deletes all Web Parts personalization data associated with the personalization scope indicated by scope.
The scope parameter is set, and the paths parameter contains at least one value. This combination deletes all Web Parts personalization data for the specified path or paths that are in the personalization scope indicated by scope.
The scope parameter is set to User, the paths parameter is set and contains only one path, and the usernames parameter contains at least one value. This combination deletes all user personalization Web Parts data for the given path that is associated with the user or users contained in usernames.
The scope parameter is set to User, the paths parameter is null, and the usernames parameter contains at least one value. This combination deletes all per-user personalization Web Parts data, across all paths, associated with the user or users contained in usernames.

Any other combination of parameter values is invalid and will throw an ArgumentException exception. For example, the following two combinations are not allowed:

The usernames parameter cannot be provided when the scope parameter is set to Shared.
The paths parameter cannot contain more than one entry when the usernames parameter is not null.

The paths and usernames parameters contained within the respective arrays must meet the following validation rules. If any validation rules fail for any member of the parameter arrays, an ArgumentException exception is thrown. The validation rules include:

null values are not allowed.
An empty string ("") after the string has been trimmed is not allowed.
No user names contained in the usernames parameter can contain commas.
The length of any path in the paths parameter cannot be greater than 256 characters.
The length of any user name in the usernames parameter cannot be greater than 256 characters.

Applies to