VGMembershipInstanceFindUsersInApplication Method (Guid, Int32, Int32, VGPrincipalSortByColumnType, VGSortOrderType, Int32)
|
Gets a collection of membership users where the application name contains the specified application name 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 FindUsersInApplication(
Guid applicationToMatch,
int pageIndex,
int pageSize,
VGPrincipalSortByColumnType sortBy,
VGSortOrderType sortOrder,
out int totalRecords
)
Public Function FindUsersInApplication (
applicationToMatch As Guid,
pageIndex As Integer,
pageSize As Integer,
sortBy As VGPrincipalSortByColumnType,
sortOrder As VGSortOrderType,
<OutAttribute> ByRef totalRecords As Integer
) As VGMembershipUserCollection
Parameters
- applicationToMatch
- Type: SystemGuid
The application name 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. - sortBy
- Type: VGPrincipalSortByColumnType
Column to sort by - VGPrincipalSortByColumnType - sortOrder
- Type: VGSortOrderType
Sorting Order - Ascedning or descending (VGSortOrderType) - 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 |
---|
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 usernameToMatch parameter value.
See Also