PersonalizationProvider.GetCountOfState Method

Definition

Namespace:

System.Web.UI.WebControls.WebParts

Assembly:

System.Web.dll

When overridden in a derived class, returns the number of rows in the underlying data store that exist within the specified scope.

public:
 abstract int GetCountOfState(System::Web::UI::WebControls::WebParts::PersonalizationScope scope, System::Web::UI::WebControls::WebParts::PersonalizationStateQuery ^ query);

public abstract int GetCountOfState (System.Web.UI.WebControls.WebParts.PersonalizationScope scope, System.Web.UI.WebControls.WebParts.PersonalizationStateQuery query);

abstract member GetCountOfState : System.Web.UI.WebControls.WebParts.PersonalizationScope * System.Web.UI.WebControls.WebParts.PersonalizationStateQuery -> int

Public MustOverride Function GetCountOfState (scope As PersonalizationScope, query As PersonalizationStateQuery) As Integer

Parameters

scope

PersonalizationScope

A PersonalizationScope of the personalization information to be queried. This value cannot be null.

query

PersonalizationStateQuery

A PersonalizationStateQuery containing a query. This value can be null.

Returns

Int32

The number of rows in the underlying data store that exist for the specified scope parameter.

Remarks

This method is the abstract definition of an administrative method for retrieving counts of personalization data. Derived implementations should follow the logic described below.

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 parameter would look like "John%".

The following query constraints apply:

• If only scope is provided, and query is null or all the properties on query return either null or default values, then all records matching the indicated scope parameter are counted.

• If the PathToMatch property is not null, the counted records are also filtered based on paths that match the PathToMatch value.

• If the UsernameToMatch property is not null, the counted records are also filtered based on user names that match the UsernameToMatch property value.

• If the UserInactiveSinceDate property is not equal to MaxValue, then the counted records are also filtered to return only those records associated with inactive users. The comparison includes records where the LastActivityDate property is less than or equal to the UserInactiveSinceDate property.

Note that this method does not validate combinations of query parameters. For example, code can request a count of personalization state records associated with a specific user name in the shared scope. Because user names are not associated with shared information, the returned count would be zero.

Parameter combinations that have the potential to return a non-zero count include:

• Shared scope in combination with the PathToMatch property.

• User scope in combination with the values for any or all of the PathToMatch, UsernameToMatch, and UserInactiveSinceDate properties.