PersonalizationAdministration.GetAllState Method (PersonalizationScope, Int32, Int32, Int32)
Assembly: System.Web (in system.web.dll)
public: static PersonalizationStateInfoCollection^ GetAllState ( PersonalizationScope scope, int pageIndex, int pageSize, [OutAttribute] int% totalRecords )
public static PersonalizationStateInfoCollection GetAllState ( PersonalizationScope scope, int pageIndex, int pageSize, /** @attribute OutAttribute() */ /** @ref */ int totalRecords )
JScript does not support passing value-type arguments by reference.
Parameters
- scope
The scope of the personalization information to be retrieved.
- pageIndex
The zero-based index of the page of results to return.
- pageSize
The number of records to return.
- totalRecords
The total number of records available.
Return Value
A PersonalizationStateInfoCollection containing state information for the specified scope and parameters.| Exception type | Condition |
|---|---|
| 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. | |
| scope is not a valid member of the PersonalizationScope enumeration. | |
| 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.
Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.
Reference
PersonalizationAdministration ClassPersonalizationAdministration Members
System.Web.UI.WebControls.WebParts Namespace
WebPartPersonalization
Other Resources
ASP.NET Web Parts PagesWeb Parts Personalization Overview
Walkthrough: Implementing Web Parts Personalization with a User Control
Web Parts Personalization