PersonalizationAdministration.GetAllInactiveUserState Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns a collection of all per-user personalization state information associated with inactive users.
Overloads
GetAllInactiveUserState(DateTime) |
Returns a collection of all per-user personalization state information associated with inactive users, based on the specified date. |
GetAllInactiveUserState(DateTime, Int32, Int32, Int32) |
Returns a subset of all per-user personalization state information associated with inactive users, based on the specified parameters. |
GetAllInactiveUserState(DateTime)
Returns a collection of all per-user personalization state information associated with inactive users, based on the specified date.
public:
static System::Web::UI::WebControls::WebParts::PersonalizationStateInfoCollection ^ GetAllInactiveUserState(DateTime userInactiveSinceDate);
public static System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection GetAllInactiveUserState (DateTime userInactiveSinceDate);
static member GetAllInactiveUserState : DateTime -> System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection
Public Shared Function GetAllInactiveUserState (userInactiveSinceDate As DateTime) As PersonalizationStateInfoCollection
Parameters
- userInactiveSinceDate
- DateTime
The last date a user's personalization information was accessed.
Returns
A collection of UserPersonalizationStateInfo instances.
Exceptions
The provider for a personalization provider defined in configuration is not of the correct type.
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
The returned collection contains only UserPersonalizationStateInfo instances. 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.
This method returns items where the user's LastActivityDate property value is less than or equal to the UserInactiveSinceDate property value. If UserInactiveSinceDate is MaxValue, this method effectively returns all per-user data in the underlying data store.
See also
- WebPartPersonalization
- ASP.NET Web Parts Controls
- Web Parts Personalization Overview
- Walkthrough: Implementing Web Parts Personalization with a User Control
- Web Parts Personalization
Applies to
GetAllInactiveUserState(DateTime, Int32, Int32, Int32)
Returns a subset of all per-user personalization state information associated with inactive users, based on the specified parameters.
public:
static System::Web::UI::WebControls::WebParts::PersonalizationStateInfoCollection ^ GetAllInactiveUserState(DateTime userInactiveSinceDate, int pageIndex, int pageSize, [Runtime::InteropServices::Out] int % totalRecords);
public static System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection GetAllInactiveUserState (DateTime userInactiveSinceDate, int pageIndex, int pageSize, out int totalRecords);
static member GetAllInactiveUserState : DateTime * int * int * int -> System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection
Public Shared Function GetAllInactiveUserState (userInactiveSinceDate As DateTime, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As PersonalizationStateInfoCollection
Parameters
- userInactiveSinceDate
- DateTime
The last date a user's personalization information was accessed.
- 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
A collection of UserPersonalizationStateInfo instances.
Exceptions
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.
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
The returned collection contains only UserPersonalizationStateInfo instances. 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.
This method returns items where the user's LastActivityDate property value is less than or equal to the UserInactiveSinceDate property value. If UserInactiveSinceDate is MaxValue, this method effectively returns all per-user data in the underlying data store.
The return values are constrained by the pageIndex
and pageSize
parameters, 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
- WebPartPersonalization
- ASP.NET Web Parts Controls
- Web Parts Personalization Overview
- Walkthrough: Implementing Web Parts Personalization with a User Control
- Web Parts Personalization