SqlPersonalizationProvider.ResetState 方法

定义

命名空间:

System.Web.UI.WebControls.WebParts

程序集:

System.Web.dll

根据指定参数从基础数据存储区中删除个性化设置状态信息。

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

参数

scope

PersonalizationScope

PersonalizationScope 用于指示要查询的个性化信息。 此值不能为 null。

paths

String[]

Shared 范围中待删除的个性化设置信息的路径。

usernames

String[]

User 范围中待删除的个性化设置信息的用户名。

返回

Int32

删除的行数。

例外

ArgumentException

paths 或 usernames 参数为空数组。

• 或 - 包含在各自数组中的 paths 和 usernames 参数不满足有效性规则。

ArgumentOutOfRangeException

指定的 scope 不是 PersonalizationScope 枚举的成员。

注解

此方法不支持通配符。

仅允许以下参数组合：

• 该 scope 参数已设置，所有其他参数都设置为 null。 此组合删除与指定scope个性化设置范围关联的所有Web 部件个性化数据。

• 该 scope 参数已设置，参数 paths 至少包含一个值。 此组合删除指定路径或路径的所有Web 部件个性化设置数据，这些路径或路径位于指定的scope个性化设置范围内。

• 参数 scope 设置为 User，参数 paths 设置且仅包含一个路径，并且 usernames 参数至少包含一个值。 此组合删除与包含usernames的用户或用户关联的给定路径的所有用户个性化Web 部件数据。

• 参数 scope 设置为 User， paths 参数为 null，参数 usernames 包含至少一个值。 此组合删除与包含在usernames内的用户或用户关联的所有路径Web 部件数据的所有每用户个性化。

参数值的任何其他组合无效，将引发 ArgumentException 异常。 例如，不允许使用以下两种组合：

• usernames如果scope参数设置为 Shared.，则无法提供该参数。

• 当参数不是null时usernames，该paths参数不能包含多个条目。

paths各数组中包含的和usernames参数必须满足以下验证规则。 如果参数数组的任何成员的任何验证规则都失败， ArgumentException 则会引发异常。 验证规则包括：

• null 不允许使用值。

• 不允许剪裁字符串后空字符串 (“”) 。

• 参数中包含的 usernames 用户名不能包含逗号。

• 参数中 paths 任何路径的长度不能大于 256 个字符。

• 参数中 usernames 任何用户名的长度不能大于 256 个字符。