PersonalizationAdministration.FindInactiveUserState Method

Definition

Namespace:

System.Web.UI.WebControls.WebParts

Assembly:

System.Web.dll

Returns a collection of per-user personalization state information for inactive users, based on the specified parameters.

Overloads

FindInactiveUserState(String, String, DateTime)	Returns a collection of per-user personalization state information for inactive users, based on the specified parameters.
FindInactiveUserState(String, String, DateTime, Int32, Int32, Int32)	Returns a collection of per-user personalization state information for inactive users, based on the specified parameters.

FindInactiveUserState(String, String, DateTime)

Returns a collection of per-user personalization state information for inactive users, based on the specified parameters.

public:
 static System::Web::UI::WebControls::WebParts::PersonalizationStateInfoCollection ^ FindInactiveUserState(System::String ^ pathToMatch, System::String ^ usernameToMatch, DateTime userInactiveSinceDate);

public static System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection FindInactiveUserState (string pathToMatch, string usernameToMatch, DateTime userInactiveSinceDate);

static member FindInactiveUserState : string * string * DateTime -> System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection

Public Shared Function FindInactiveUserState (pathToMatch As String, usernameToMatch As String, userInactiveSinceDate As DateTime) As PersonalizationStateInfoCollection

Parameters

pathToMatch

String

The path of the page to match.

usernameToMatch

String

The user name to match that has personalization data associated with the page.

userInactiveSinceDate

DateTime

The last date a user's personalization information was accessed.

Returns

PersonalizationStateInfoCollection

A PersonalizationStateInfoCollection that contains per-user personalization state information.

Exceptions

ArgumentException

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

-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, per-user personalization state information where the pathToMatch parameter value matches the path of a page, usernameToMatch matches a user name that has personalization data associated with that page, and the users are considered inactive. In other words, for each returned record the user's LastActivityDate property value is less than or equal to userInactiveSinceDate. The returned collection contains only UserPersonalizationStateInfo instances.

This method passes query wildcard characters to the underlying data store. Support for wildcard characters is currently dependent on how each 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%".

Likewise, a wildcard search on a partial user name could have the wildcard character appear at any point in the text string of the UsernameToMatch property. For example, to find all user names that start with "John", the UsernameToMatch property would look like "John%".

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.

If userInactiveSinceDate is MaxValue, then the returned values from this method are equivalent to FindUserState.

Both pathToMatch and usernameToMatch can be null. The usernameToMatch parameter can include commas (,) because some data stores, such as those running Microsoft SQL Server, allow commas as wildcard characters.

See also

• WebPartPersonalization
• ASP.NET Web Parts Controls
• Web Parts Personalization Overview
• Walkthrough: Implementing Web Parts Personalization with a User Control
• Web Parts Personalization

FindInactiveUserState(String, String, DateTime, Int32, Int32, Int32)

Returns a collection of per-user personalization state information for inactive users, based on the specified parameters.

public:
 static System::Web::UI::WebControls::WebParts::PersonalizationStateInfoCollection ^ FindInactiveUserState(System::String ^ pathToMatch, System::String ^ usernameToMatch, DateTime userInactiveSinceDate, int pageIndex, int pageSize, [Runtime::InteropServices::Out] int % totalRecords);

public static System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection FindInactiveUserState (string pathToMatch, string usernameToMatch, DateTime userInactiveSinceDate, int pageIndex, int pageSize, out int totalRecords);

static member FindInactiveUserState : string * string * DateTime * int * int * int -> System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection

Public Shared Function FindInactiveUserState (pathToMatch As String, usernameToMatch As String, userInactiveSinceDate As DateTime, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As PersonalizationStateInfoCollection

Parameters

pathToMatch

String

The path of the page to match.

usernameToMatch

String

The user name to match that has personalization data associated with the page.

userInactiveSinceDate

DateTime

The last date 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

PersonalizationStateInfoCollection

A PersonalizationStateInfoCollection that contains per-user personalization state information.

Exceptions

ArgumentException

pathToMatch or usernameToMatch 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, per-user personalization state information where the pathToMatch parameter value matches the path of a page, usernameToMatch matches a user name that has personalization data associated with that page, and the users are considered inactive. In other words, for each returned record the user's LastActivityDate property value is less than or equal to userInactiveSinceDate. The collection contains only UserPersonalizationStateInfo 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%".

Likewise, a wildcard search on a partial user name could have the wildcard character appear at any point in the text string of the UsernameToMatch property. For example, to find all user names that start with "John", the UsernameToMatch property would look like "John%".

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.

If userInactiveSinceDate is MaxValue, then the returned values from this method are equivalent to FindUserState.

Both pathToMatch and usernameToMatch can be null. The usernameToMatch parameter can have commas (,) because some data stores, such as those running Microsoft SQL Server, allow commas as wildcard characters.

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

• WebPartPersonalization
• ASP.NET Web Parts Controls
• Web Parts Personalization Overview
• Walkthrough: Implementing Web Parts Personalization with a User Control
• Web Parts Personalization