Membership::FindUsersByEmail Method (String^, Int32, Int32, Int32%)

 

Gets a collection of membership users, in a page of data, 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,
	int pageIndex,
	int pageSize,
	[OutAttribute] int% totalRecords
)

Parameters

emailToMatch
Type: System::String^

The e-mail address to search for.

pageIndex
Type: System::Int32

The index of the page of results to return. pageIndex is zero-based.

pageSize
Type: System::Int32

The size of the page of results to return.

totalRecords
Type: System::Int32%

The total number of matched users.

Return Value

Type: System.Web.Security::MembershipUserCollection^

A MembershipUserCollection that contains a page of pageSizeMembershipUser objects beginning at the page specified by pageIndex.

Exception Condition
ArgumentException

pageIndex is less than zero.

-or-

pageSize is less than 1.

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 results returned by FindUsersByEmail are constrained by the pageIndex and pageSize parameters. The pageSize parameter identifies the maximum number of MembershipUser objects to return in the MembershipUserCollection. The pageIndex parameter identifies which page of results to return, where 0 identifies the first page. The totalRecords parameter is an out parameter that is set to the total number of membership users that matched the emailToMatch value. For example, if 13 users were found where emailToMatch matched part of or the entire e-mail address, and the pageIndex value was 1 with a pageSize of 5, the MembershipUserCollection returned would contain the sixth through the tenth users returned. totalRecords would be set to 13.

Leading and trailing spaces are trimmed from 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.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
Show: