PersonalizationAdministration.GetCountOfUserState Method
Assembly: System.Web (in system.web.dll)
public static int GetCountOfUserState ( String usernameToMatch )
public static function GetCountOfUserState ( usernameToMatch : String ) : int
Parameters
- usernameToMatch
The user name associated with the personalization state information to retrieve.
Return Value
The number of personalization state items for the specified user.| Exception type | Condition |
|---|---|
| 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. |
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 a null reference (Nothing in Visual Basic). If set to a null reference (Nothing in Visual Basic), 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.
Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.
Reference
PersonalizationAdministration ClassPersonalizationAdministration Members
System.Web.UI.WebControls.WebParts Namespace
WebPartPersonalization
Other Resources
ASP.NET Web Parts PagesWeb Parts Personalization Overview
Walkthrough: Implementing Web Parts Personalization with a User Control
Web Parts Personalization