PersonalizationAdministration.GetCountOfInactiveUserState Method (String, DateTime)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns a count of the per-user personalization items in the underlying data store for inactive users, based on the specified parameters.

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

public static int GetCountOfInactiveUserState(
	string pathToMatch,
	DateTime userInactiveSinceDate
)

Parameters

pathToMatch
Type: System.String

The path to the page with personalization state items to retrieve.

userInactiveSinceDate
Type: System.DateTime

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

Return Value

Type: System.Int32

The count of the per-user personalization items in the underlying data store for inactive users.

Exception Condition
ArgumentException

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

HttpException

The default provider returned a negative number for the count.

This method returns records where the page matches the specified pathtoMatch parameter and the user's LastActivityDate property value is less than or equal to the UserInactiveSinceDate property value. If UserInactiveSinceDate is set to MaxValue, a count of all users' personalization information is returned.

Note that the pathToMatch parameter can include wildcard characters. The method passes wildcard characters to the underlying data store. Wildcard character support 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%".

The pathToMatch parameter can be null. If set to null, the parameter is ignored when performing queries.

.NET Framework
Available since 2.0
Return to top
Show: