PersonalizationAdministration.GetCountOfUserState(String) Method

Definition

Returns a count of the personalization state items in the underlying data store that exist for the specified user.

public:
 static int GetCountOfUserState(System::String ^ usernameToMatch);
public static int GetCountOfUserState (string usernameToMatch);
static member GetCountOfUserState : string -> int
Public Shared Function GetCountOfUserState (usernameToMatch As String) As Integer

Parameters

usernameToMatch
String

The user name associated with the personalization state information to retrieve.

Returns

The number of personalization state items for the specified user.

Exceptions

usernameToMatch is an empty string ("") after trimming.

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

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 default provider returned a negative number for the count.

Remarks

This method returns a count of the number of per-user personalization items in the underlying data store that exist for the given usernameToMatch.

Note that the usernameToMatch parameter can include wildcard characters. This 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, a wildcard search on a partial user name can 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 usernameToMatch parameter can be null. If set to null, the parameter is ignored when performing queries. The usernameToMatch parameter is allowed to have commas (,) because some data stores, such as those running Microsoft SQL Server, allow commas as wildcard characters.

Applies to

See also