This documentation is archived and is not being maintained.

PersonalizationAdministration.FindSharedState Method (String)

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

Namespace:  System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)

public static PersonalizationStateInfoCollection FindSharedState(
	string pathToMatch
)

Parameters

pathToMatch
Type: System.String
The path of the page to match.

Return Value

Type: System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection
A PersonalizationStateInfoCollection that contains shared personalization state information.

ExceptionCondition
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.

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.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: