Membership.FindUsersByName Method (String) (System.Web.Security)

FindUsersByName Method (String)

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

Membership..::.FindUsersByName Method (String)

Gets a collection of membership users where the user name contains the specified user name to match.

Namespace: System.Web.Security
Assembly: System.Web (in System.Web.dll)

Syntax

Visual Basic (Declaration)

Public Shared Function FindUsersByName ( _
    usernameToMatch As String _
) As MembershipUserCollection

Visual Basic (Usage)

Dim usernameToMatch As String
Dim returnValue As MembershipUserCollection

returnValue = Membership.FindUsersByName(usernameToMatch)

public static MembershipUserCollection FindUsersByName(
    string usernameToMatch
)

Visual C++

public:
static MembershipUserCollection^ FindUsersByName(
    String^ usernameToMatch
)

JScript

public static function FindUsersByName(
    usernameToMatch : String
) : MembershipUserCollection

Parameters

usernameToMatch: Type: System..::.String
The user name to search for.

Return Value

Type: System.Web.Security..::.MembershipUserCollection
A MembershipUserCollection that contains all users that match the usernameToMatch parameter.
Leading and trailing spaces are trimmed from the usernameToMatch parameter value.

Exceptions

Exception	Condition
ArgumentException	usernameToMatch is an empty string.
ArgumentNullException	usernameToMatch is nullNothingnullptra null reference (Nothing in Visual Basic).

Remarks

FindUsersByName returns a list of membership users where the user name matches the supplied usernameToMatch for the configured applicationName.

The SqlMembershipProvider performs its search using a LIKE clause against the usernameToMatch parameter. Any wildcards that are supported by SQL Server in LIKE clauses can be used in the usernameToMatch parameter value.

Leading and trailing spaces are trimmed from all parameter values.

Examples

The following code example uses the FindUsersByName method to retrieve membership user information from the membership database based on user input and displays the results in pages of data.

Security Note:
This example contains 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.

Visual Basic

<%@ Page Language="VB" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

Public Sub GoButton_OnClick(sender As Object, args As EventArgs)
  UserGrid.DataSource = Membership.FindUsersByName(UsernameTextBox.Text)
  UserGrid.DataBind()
End Sub

</script>
<html  >
<head>
<title>Sample: Find Users</title>
</head>
<body>

<form id="form1" runat="server">
  <h3>User List</h3>

  Username to Search for: 
    <asp:TextBox id="UsernameTextBox" runat="server" />
    <asp:Button id="GoButton" Text=" Go " OnClick="GoButton_OnClick" runat="server" /><br />

  <asp:DataGrid id="UserGrid" runat="server"
                CellPadding="2" CellSpacing="1"
                Gridlines="Both">
    <HeaderStyle BackColor="darkblue" ForeColor="white" />
  </asp:DataGrid>

</form>

</body>
</html>

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

public void GoButton_OnClick(object sender, EventArgs args)
{
  UserGrid.DataSource = Membership.FindUsersByName(UsernameTextBox.Text);
  UserGrid.DataBind();
}

</script>
<html  >
<head>
<title>Sample: Find Users</title>
</head>
<body>

<form id="form1" runat="server">
  <h3>User List</h3>

  Username to Search for: 
    <asp:TextBox id="UsernameTextBox" runat="server" />
    <asp:Button id="GoButton" Text=" Go " OnClick="GoButton_OnClick" runat="server" /><br />

  <asp:DataGrid id="UserGrid" runat="server"
                CellPadding="2" CellSpacing="1"
                Gridlines="Both">
    <HeaderStyle BackColor="darkblue" ForeColor="white" />
  </asp:DataGrid>

</form>

</body>
</html>

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

Membership Class

Membership Members

FindUsersByName Overload

System.Web.Security Namespace

Other Resources

Introduction to Membership