Export (0) Print
Expand All

PersonalizationAdministration.GetAllState Method (PersonalizationScope, Int32, Int32, Int32%)

Returns a subset of all personalization state information from the underlying data store, based on the specified parameters.

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

public static PersonalizationStateInfoCollection GetAllState(
	PersonalizationScope scope,
	int pageIndex,
	int pageSize,
	out int totalRecords
)

Parameters

scope
Type: System.Web.UI.WebControls.WebParts.PersonalizationScope
The scope of the personalization information to be retrieved.
pageIndex
Type: System.Int32
The zero-based index of the page of results to return.
pageSize
Type: System.Int32
The number of records to return.
totalRecords
Type: System.Int32%
The total number of records available.

Return Value

Type: System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection
A PersonalizationStateInfoCollection containing state information for the specified scope and parameters.

ExceptionCondition
ArgumentException

pageIndex is less than zero.

- or -

pageSize is less than or equal to zero.

- or -

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

- or -

The combination of pageIndex and pageSize exceeds MaxValue.

ArgumentOutOfRangeException

scope is not a valid member of the PersonalizationScope enumeration.

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.

The items in the collection returned are based primarily on scope, and then the records corresponding to that scope are further reduced to a subset based on the pageIndex and pageSize parameters. The collection returned contains either SharedPersonalizationStateInfo instances only, or UserPersonalizationStateInfo instances only.

The items returned are constrained by the pageIndex and pageSize parameters, where pageIndex controls which records to return and pageSize controls the number of records returned. 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.

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.

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

Community Additions

ADD
Show:
© 2015 Microsoft