VGMembershipInstanceFindUsersByAuthenticationMode Method (VGAuthenticationMode, Int32, Int32, Int32)
|
Gets a collection of membership users where the user authentication mode contains the specified user authentication mode to match.
Namespace:
Novalys.VisualGuard.Security.Membership
Assembly:
Novalys.VisualGuard.Security (in Novalys.VisualGuard.Security.dll) Version: 2019.1.831.19 (2019.1.0831.19)
Syntax public VGMembershipUserCollection FindUsersByAuthenticationMode(
VGAuthenticationMode authenticationModeToMatch,
int pageIndex,
int pageSize,
out int totalRecords
)
Public Function FindUsersByAuthenticationMode (
authenticationModeToMatch As VGAuthenticationMode,
pageIndex As Integer,
pageSize As Integer,
<OutAttribute> ByRef totalRecords As Integer
) As VGMembershipUserCollection
Parameters
- authenticationModeToMatch
- Type: Novalys.VisualGuard.SecurityVGAuthenticationMode
A VGAuthenticationMode object that represents the user authentication mode to search for. - pageIndex
- Type: SystemInt32
The index of the page of results to return. pageIndex is zero-based. - pageSize
- Type: SystemInt32
The size of the page of results to return. - totalRecords
- Type: SystemInt32
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.
Exceptions Exception | Condition |
---|
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 |
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. |
Remarks Wildcards such as asterisks and question marks can be used in the authenticationModeToMatch parameter value.
See Also