Membership.FindUsersByEmail Method (String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets a collection of membership users where the e-mail address contains the specified e-mail address to match.

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

public static MembershipUserCollection FindUsersByEmail(
	string emailToMatch
)

Parameters

emailToMatch
Type: System.String

The e-mail address to search for.

Return Value

Type: System.Web.Security.MembershipUserCollection

A MembershipUserCollection that contains all users that match the emailToMatch parameter.

Leading and trailing spaces are trimmed from the emailToMatch parameter value.

FindUsersByEmail returns a list of membership users where the e-mail address matches the supplied emailToMatch for the configured applicationName.

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

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

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

<%@ 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.FindUsersByEmail(EmailTextBox.Text);
  UserGrid.DataBind();
}

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>Sample: Find Users by Email</title>
</head>
<body>

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

  E-mail address to Search for: 
    <asp:TextBox id="EmailTextBox" 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>

.NET Framework
Available since 2.0
Return to top
Show: