Gets a collection of membership users where the user name contains the specified user name to match.

Namespace: Novalys.VisualGuard.Security.WebForm
Assembly: Novalys.VisualGuard.Security.WebForm (in Novalys.VisualGuard.Security.WebForm.dll) Version: 2017.0.101.17 (2017.0.101.17)

Syntax

C#
public override MembershipUserCollection FindUsersByName(
	string usernameToMatch,
	int pageIndex,
	int pageSize,
	out int totalRecords
)
Visual Basic
Public Overrides Function FindUsersByName ( 
	usernameToMatch As String,
	pageIndex As Integer,
	pageSize As Integer,
	<OutAttribute> ByRef totalRecords As Integer
) As MembershipUserCollection

Parameters

usernameToMatch
Type: System..::..String
The user name to search for. this expression must be a valid regular expression.
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: MembershipUserCollection
A MembershipUserCollection that contains a page of pageSizeMembershipUser objects beginning at the page specified by pageIndex.

Remarks

Wildcards such as asterisks, question, percent, underscore marks can be used in the usernameToMatch parameter value.

Exceptions

ExceptionCondition
System..::..ArgumentException usernameToMatch 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

See Also