PersonalizationAdministration.FindUserState Method (String, String)


Returns a collection of per-user personalization state information based on the user name and page path.

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

public static PersonalizationStateInfoCollection FindUserState(
	string pathToMatch,
	string usernameToMatch


Type: System.String

The path of the page to match.

Type: System.String

The user name to match that has personalization data associated with the page.

Return Value

Type: System.Web.UI.WebControls.WebParts.PersonalizationStateInfoCollection

A PersonalizationStateInfoCollection that contains per-user personalization state information.

Exception Condition

pathToMatch or usernameToMatch before or 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.


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.

This method returns a collection of UserPersonalizationStateInfo instances where the pathToMatch parameter value matches the path of a page, and usernameToMatch matches a user name that has personalization data associated with that page. The collection contains only UserPersonalizationStateInfo instances.

This method passes parameter wildcard characters to the underlying personalization provider, so how the data store handles these characters depends on how the 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 property would look like "John%".

Using the default personalization provider, the PersonalizationStateInfo-derived objects are returned in alphabetical order, and sorted by a combination of path and user name in ascending order. The ordering of the objects in the collection is determined by the provider.

Both pathToMatch and usernameToMatch can be null. The usernameToMatch parameter can have commas (,) because some data stores, such as those running Microsoft SQL Server, allow commas as wildcard characters.

The following code example demonstrates how to use the FindUserState method. The complete example can be found in the PersonalizationAdministration class overview topic.

System_CAPS_security Security Note

This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

protected void Button1_Click(object sender, EventArgs e)
    if (TextBox3.Text != null)
        PersonalizationStateInfoCollection findresult;
      findresult = PersonalizationAdministration.FindUserState(null, TextBox3.Text);
      if (findresult.Count != 0)
          Label4.Text = findresult.Count + "  user(s) found";
          Label4.Visible = true;
          Label4.Text = "No users found.";
          Label4.Visible = true;
      Label4.Text = "You must enter a user name to find.";


.NET Framework
Available since 2.0
Return to top