Gets a collection of membership users where the user name contains the specified user name to match.
Namespace:
Novalys.VisualGuard.Security.WebFormAssembly: Novalys.VisualGuard.Security.WebForm (in Novalys.VisualGuard.Security.WebForm.dll) Version: 3.2.912.1 (3.2.912.01)
Syntax
C# |
---|
public override MembershipUserCollection FindUsersByName( string usernameToMatch, int pageIndex, int pageSize, out int totalRecords ) |
Visual Basic (Declaration) |
---|
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
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
Exception | Condition |
---|---|
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 |