Provider. Find Users ByEmail(String, Int32, Int32, Int32) Method
Gets a collection of membership users where the email address contains the specified email address to match.
public: abstract System::Web::Security::MembershipUserCollection ^ FindUsersByEmail(System::String ^ emailToMatch, int pageIndex, int pageSize, [Runtime::InteropServices::Out] int % totalRecords);
public abstract System.Web.Security.MembershipUserCollection FindUsersByEmail (string emailToMatch, int pageIndex, int pageSize, out int totalRecords);
abstract member FindUsersByEmail : string * int * int * int -> System.Web.Security.MembershipUserCollection
Public MustOverride Function FindUsersByEmail (emailToMatch As String, pageIndex As Integer, pageSize As Integer, ByRef totalRecords As Integer) As MembershipUserCollection
The email address to search for.
The index of the page of results to return.
pageIndex is zero-based.
The size of the page of results to return.
The total number of matched users.
FindUsersByEmail returns a list of membership users where the user's email address matches the supplied
emailToMatch for the configured ApplicationName property. If your data source supports additional search capabilities, such as wildcard characters, you can provide more extensive search capabilities for email addresses.
The results returned by FindUsersByEmail are constrained by the
pageSize parameters. The
pageSize parameter identifies the number of MembershipUser objects to return in the MembershipUserCollection collection. 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 email address, and the
pageIndex value was 1 with a
pageSize of 5, then the MembershipUserCollection would contain the sixth through the tenth users returned.
totalRecords would be set to 13.