Muokkaa

Jaa

PersonalizationAdministration.FindSharedState Method

  • Reference

Definition

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

Returns a collection of shared personalization state information based on the specified parameters.

Overloads

FindSharedState(String)

Returns a collection of shared personalization state information based on the specified path.
FindSharedState(String, Int32, Int32, Int32)

Returns a collection of shared personalization state information based on the specified parameters.

FindSharedState(String)

Returns a collection of shared personalization state information based on the specified path.

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

Parameters

pathToMatch
String

The path of the page to match.

Returns

PersonalizationStateInfoCollection

A PersonalizationStateInfoCollection that contains shared personalization state information.

Exceptions

ArgumentException

pathToMatch is an empty string ("") either before or after trimming.

-or-

The provider for a personalization provider defined in configuration is not of the correct type.

-or-

The length of the string of any parameter is greater than 256 characters.

ConfigurationErrorsException

A configuration exception occurred while attempting to create and initialize an instance of one of the configured personalization providers.

-or-

The default personalization provider defined in configuration could not be found.

Remarks

This method returns a collection of UserPersonalizationStateInfo instances where the pathToMatch value matches the path of a page that has shared personalization state data. The collection contains only SharedPersonalizationStateInfo instances.

This method passes parameter wildcard characters to the underlying personalization provider, so how the data store handles these characters depends on how the provider handles characters such as an asterisk (*), a percent symbol (%), or an underscore (_).

Normally, for SQL-compliant data stores, you can perform a wildcard search on a partial path with the wildcard character appearing at the beginning, the end, or the middle of the search string text in the PathToMatch property. For example, to find all paths that start with "~/vdir", the PathToMatch property would be set to "~/vdir%".

Using the default personalization provider, the PersonalizationStateInfo-derived objects are returned in alphabetical order, and sorted by a combination of path and user name in ascending order. The ordering of the objects in the collection is determined by the provider.

The pathToMatch parameter can be null. If set to null, the parameter is ignored when performing queries.

See also

Applies to

FindSharedState(String, Int32, Int32, Int32)

Returns a collection of shared personalization state information based on the specified parameters.

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

Parameters

pathToMatch
String

The path of the page to match.

pageIndex
Int32

The zero-based index of the page of results to return.

pageSize
Int32

The number of records to return.

totalRecords
Int32

The total number of records available.

Returns

PersonalizationStateInfoCollection

A PersonalizationStateInfoCollection that contains shared personalization state information.

Exceptions

ArgumentException

pathToMatch before or after trimming is an empty string ("").

-or-

pageIndex is less than zero.

-or-

pageSize is less than or equal to zero.

-or-

The combination of pageIndex and pageSize exceeds Int32.MaxValue.

-or-

The provider for a personalization provider defined in configuration is not of the correct type.

-or-

The length of the string of any parameter is greater than 256 characters.

ConfigurationErrorsException

A configuration exception occurred while attempting to create and initialize an instance of one of the configured personalization providers.

-or-

The default personalization provider defined in configuration could not be found.

Remarks

This method returns a collection of UserPersonalizationStateInfo instances where the pathToMatch value matches the path of a page that has shared personalization state data. The collection contains only SharedPersonalizationStateInfo instances.

This method passes parameter wildcard characters to the underlying personalization provider, so how the data store handles these characters depends on how the provider handles characters such as an asterisk (*), a percent symbol (%), or an underscore (_).

Normally, for SQL-compliant data stores, you can perform a wildcard search on a partial path with the wildcard character appearing at the beginning, the end, or the middle of the search string text in the PathToMatch property. For example, to find all paths that start with "~/vdir", the PathToMatch property would be set to "~/vdir%".

Using the default personalization provider, the PersonalizationStateInfo-derived objects are returned in alphabetical order, and sorted by a combination of path and user name in ascending order. The order of the objects in the collection is determined by the provider.

The pathToMatch parameter can be null. If set to null, the parameter is ignored when performing queries.

The data returned is constrained by pageIndex and pageSize, where pageIndex controls which records to return and pageSize controls the number of records to return. For example, if pageIndex was set to 0 and pageSize was set to 25, the data returned would be the first 25 entries. If pageIndex was set to 1 and pageSize was set to 25, the data returned would be entries 26 to 50. The totalRecords parameter returns the total number of records that are available.

See also

Applies to