PersonalizationProvider.ResetState 方法

定义

命名空间:

System.Web.UI.WebControls.WebParts

程序集:

System.Web.dll

在派生类中重写时，根据指定的参数从基础数据存储区删除个性化设置状态。

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

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

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

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

参数

scope

PersonalizationScope

要重置的个性化设置信息的 PersonalizationScope。 此值不能为 null。

paths

String[]

要删除的个性化设置信息的路径。

usernames

String[]

要删除的个性化设置信息的用户名。

返回

Int32

删除的行数。

注解

此方法是删除个性化设置数据的管理方法的抽象定义。 派生实现应遵循下面所述的逻辑。

此方法不支持通配符搜索。 如果个性化设置提供程序公开来自事务感知数据存储的数据，此方法应作为单个原子事务执行其操作。

仅允许以下参数组合：

• scope设置了 参数，所有其他参数都设置为 null 。 此组合会Web 部件所指示的个性化设置范围关联的所有个性化设置数据 scope 。

• scope参数已设置， paths 并且参数至少包含一个值。 此组合将删除Web 部件范围中指定路径的所有个性化设置数据 scope 。

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

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

任何其他参数值组合都无效，将引发 ArgumentException 异常。 具体而言，不允许以下两种组合：

• 当 usernames 设置为 时， scope 无法提供 参数 Shared 。

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

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

• null 不允许使用 值。

• 不允许使用 ("") 字符串。 在执行空字符串检查之前，应剪裁参数。

• 参数 usernames 不能包含逗号 () 。

• 对于数据库，参数的长度不能超过 paths 256 SQL。

• 对于数据库，参数的长度不能超过 usernames 256 SQL。