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: Novalys.VisualGuard.Security.Membership
Assembly: Novalys.VisualGuard.Security (in Novalys.VisualGuard.Security.dll) Version: 2016.0.105.16 (2016.0.105.16)

Syntax

C#
public static VGMembershipUserCollection FindUsersByEmail(
	string emailToMatch,
	int pageIndex,
	int pageSize,
	out int totalRecords
)
Visual Basic
Public Shared Function FindUsersByEmail ( 
	emailToMatch As String,
	pageIndex As Integer,
	pageSize As Integer,
	<OutAttribute> ByRef totalRecords As Integer
) As VGMembershipUserCollection

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: VGMembershipUserCollection
A VGMembershipUserCollection that contains a page of VGMembershipUser objects beginning at the page specified by pageIndex.

Remarks

Wildcards such as asterisks and question marks can be used in the emailToMatch parameter value.

Exceptions

ExceptionCondition
System..::..ArgumentException emailToMatch is longer than 64 characters.

-or -

pageIndex is less than 0.

-or -

pageSize is less than 1.

-or -

pageSize multiplied by pageIndex, plus pageSize, minus 1 is greater than MaxValue
System.Security..::..SecurityExceptionThe current user does not have enough privileges to use Membership API. The Membership access level of the application must be sufficient to allows this action or the 'Membership Manager' role must be granted to the user by using the Visual Guard console.

See Also