PersonalizationAdministration.FindSharedState 方法

定义

基于指定参数返回共享个性化状态信息的集合。

重载

FindSharedState(String)

基于指定路径返回共享个性化设置状态的信息集合。

FindSharedState(String, Int32, Int32, Int32)

基于指定参数返回共享个性化状态信息的集合。

FindSharedState(String)

基于指定路径返回共享个性化设置状态的信息集合。

public:
 static System::Web::UI::WebControls::WebParts::PersonalizationStateInfoCollection ^ FindSharedState(System::String ^ pathToMatch);
public static System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection FindSharedState (string pathToMatch);
static member FindSharedState : string -> System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection
Public Shared Function FindSharedState (pathToMatch As String) As PersonalizationStateInfoCollection

参数

pathToMatch
String

要匹配的页面的路径。

返回

包含共享的个性化状态信息的 PersonalizationStateInfoCollection

例外

pathToMatch 在修整前或修整后是空字符串 ("")。

- 或 -

配置中定义的个性化设置提供程序的提供程序类型不正确。

- 或 -

任何参数的字符串长度超过 256 个字符。

尝试创建和初始化已配置的个性化设置提供程序的一个实例时出现配置异常。

- 或 -

找不到配置中定义的默认个性化设置提供程序。

注解

此方法返回实例的 UserPersonalizationStateInfo 集合, pathToMatch 其中 值与具有共享个性化设置状态数据的页面的路径匹配。 集合仅 SharedPersonalizationStateInfo 包含 实例。

此方法将参数通配符传递给基础个性化设置提供程序,因此数据存储如何处理这些字符取决于提供程序如何处理诸如星号 (*) 、百分比符号 (%) 或下划线 (_) 等字符。

通常,对于符合 SQL 的数据存储,可以对部分路径执行通配符搜索,其中通配符出现在 属性中 PathToMatch 搜索字符串文本的开头、结尾或中间。 例如,若要查找以“~/vdir”开头的所有路径,属性 PathToMatch 将设置为“~/vdir%”。

使用默认个性化设置提供程序时, PersonalizationStateInfo将按字母顺序返回派生的对象,并按路径和用户名的组合按升序排序。 集合中对象的排序由提供程序确定。

参数 pathToMatch 可以是 null。 如果设置为 null,则执行查询时将忽略 参数。

另请参阅

适用于

FindSharedState(String, Int32, Int32, Int32)

基于指定参数返回共享个性化状态信息的集合。

public:
 static System::Web::UI::WebControls::WebParts::PersonalizationStateInfoCollection ^ FindSharedState(System::String ^ pathToMatch, int pageIndex, int pageSize, [Runtime::InteropServices::Out] int % totalRecords);
public static System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection FindSharedState (string pathToMatch, int pageIndex, int pageSize, out int totalRecords);
static member FindSharedState : string * int * int * int -> System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection
Public Shared Function FindSharedState (pathToMatch As String, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As PersonalizationStateInfoCollection

参数

pathToMatch
String

要匹配的页面的路径。

pageIndex
Int32

要返回的结果页的索引(从零开始)。

pageSize
Int32

要返回的记录数。

totalRecords
Int32

可用记录的总数。

返回

包含共享的个性化状态信息的 PersonalizationStateInfoCollection

例外

pathToMatch 在修整前或修整后是空字符串 ("")。

- 或 -

pageIndex 小于零。

pageSize 小于或等于零。

- 或 -

pageSize 的组合pageIndex超过了 Int32.MaxValue

- 或 -

配置中定义的个性化设置提供程序的提供程序类型不正确。

- 或 -

任何参数的字符串长度超过 256 个字符。

尝试创建和初始化已配置的个性化设置提供程序的一个实例时出现配置异常。

- 或 -

找不到配置中定义的默认个性化设置提供程序。

注解

此方法返回实例的 UserPersonalizationStateInfo 集合, pathToMatch 其中 值与具有共享个性化设置状态数据的页面的路径匹配。 集合仅 SharedPersonalizationStateInfo 包含 实例。

此方法将参数通配符传递给基础个性化设置提供程序,因此数据存储如何处理这些字符取决于提供程序如何处理诸如星号 (*) 、百分比符号 (%) 或下划线 (_) 等字符。

通常,对于符合 SQL 的数据存储,可以对部分路径执行通配符搜索,其中通配符出现在 属性中 PathToMatch 搜索字符串文本的开头、结尾或中间。 例如,若要查找以“~/vdir”开头的所有路径,属性 PathToMatch 将设置为“~/vdir%”。

使用默认个性化设置提供程序时, PersonalizationStateInfo将按字母顺序返回派生的对象,并按路径和用户名的组合按升序排序。 集合中对象的顺序由提供程序确定。

参数 pathToMatch 可以是 null。 如果设置为 null,则执行查询时将忽略 参数。

返回的数据受 pageIndexpageSize的约束,其中 pageIndex 控制要返回的记录和控制 pageSize 要返回的记录数。 例如,如果 pageIndex 设置为 0 且 pageSize 设置为 25,则返回的数据将是前 25 个条目。 如果 pageIndex 设置为 1 且 pageSize 设置为 25,则返回的数据将是条目 26 到 50。 参数 totalRecords 返回可用记录的总数。

另请参阅

适用于