Gets a collection of membership users where the user authentication mode contains the specified user authentication mode to match.
Namespace: Novalys.VisualGuard.Security.MembershipAssembly: Novalys.VisualGuard.Security (in Novalys.VisualGuard.Security.dll) Version: 2017.0.101.17 (2017.0.101.17)
Syntax
C# |
---|
public VGMembershipUserCollection FindUsersByAuthenticationMode( VGAuthenticationMode authenticationModeToMatch, int pageIndex, int pageSize, VGPrincipalSortByColumnType sortBy, VGSortOrderType sortOrder, out int totalRecords ) |
Visual Basic |
---|
Public Function FindUsersByAuthenticationMode ( authenticationModeToMatch As VGAuthenticationMode, pageIndex As Integer, pageSize As Integer, sortBy As VGPrincipalSortByColumnType, sortOrder As VGSortOrderType, <OutAttribute> ByRef totalRecords As Integer ) As VGMembershipUserCollection |
Parameters
- authenticationModeToMatch
- Type: Novalys.VisualGuard.Security..::..VGAuthenticationMode
A VGAuthenticationMode object that represents the user authentication mode 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.
- sortBy
- Type: VGPrincipalSortByColumnType
Column to sort by - VGPrincipalSortByColumnType
- sortOrder
- Type: VGSortOrderType
Sorting Order - Ascedning or descending (VGSortOrderType)
- totalRecords
- Type: System..::..Int32%
The total number of matched users.
Return Value
Type: VGMembershipUserCollectionA 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 authenticationModeToMatch parameter value.
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentException |
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..::..SecurityException | The 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. |