Share via


FindUsersByEmail Method (String, Int32, Int32, Boolean, Int32)

Returns a collection of membership users whose email address match the search criteria. The total number of users matching the query are available.

Namespace:  Microsoft.CommerceServer.Runtime.Profiles
Assembly:  Microsoft.CommerceServer.Runtime (in Microsoft.CommerceServer.Runtime.dll)

Syntax

'Declaration
Public Overridable Function FindUsersByEmail ( _
    emailToMatch As String, _
    pageIndex As Integer, _
    pageSize As Integer, _
    exactMatch As Boolean, _
    <OutAttribute> ByRef totalRecords As Integer _
) As MembershipUserCollection
'Usage
Dim instance As UpmMembershipProvider
Dim emailToMatch As String
Dim pageIndex As Integer
Dim pageSize As Integer
Dim exactMatch As Boolean
Dim totalRecords As Integer
Dim returnValue As MembershipUserCollection

returnValue = instance.FindUsersByEmail(emailToMatch, _
    pageIndex, pageSize, exactMatch, _
    totalRecords)
public virtual MembershipUserCollection FindUsersByEmail(
    string emailToMatch,
    int pageIndex,
    int pageSize,
    bool exactMatch,
    out int totalRecords
)
public:
virtual MembershipUserCollection^ FindUsersByEmail(
    String^ emailToMatch, 
    int pageIndex, 
    int pageSize, 
    bool exactMatch, 
    [OutAttribute] int% totalRecords
)
public function FindUsersByEmail(
    emailToMatch : String, 
    pageIndex : int, 
    pageSize : int, 
    exactMatch : boolean, 
    totalRecords : int
) : MembershipUserCollection

Parameters

  • emailToMatch
    Type: System..::.String
    Email address to look for. Use '%' as a wildcard.
  • exactMatch
    Type: System..::.Boolean
    Declares whether an exact match is required. true to indicate that exact match is required; otherwise false.
  • totalRecords
    Type: System..::.Int32%
    The total number of users matching the query.

Return Value

Type: System.Web.Security..::.MembershipUserCollection
Returns a collection of users whose email address match search criteria.

Remarks

Returns a collection of users whose email address match search criteria. The System.Web.Security.MembershipUserCollection contains a page of pageSizeSystem.Web.Security.MembershipUser objects beginning at the page specified by pageIndex.

emailToMatch is trimmed before the search begins.

The totalRecords parameter is an out parameter that is set to the total number of matching membership users found in the membership data store.

Permissions

See Also

Reference

UpmMembershipProvider Class

UpmMembershipProvider Members

FindUsersByEmail Overload

Microsoft.CommerceServer.Runtime.Profiles Namespace