Export (0) Print
Expand All

PersonalizationAdministration.GetCountOfUserState Method

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

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

public static int GetCountOfUserState(
	string usernameToMatch
)

Parameters

usernameToMatch
Type: System.String
The user name associated with the personalization state information to retrieve.

Return Value

Type: System.Int32
The number of personalization state items for the specified user.

ExceptionCondition
ArgumentException

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.

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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft