VGMembershipInstanceGetAllUsers Method (Int32, Int32, VGPrincipalSortByColumnType, VGSortOrderType, Int32)
|
Gets a collection of all the users in the repository in pages of data.
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 GetAllUsers(
int pageIndex,
int pageSize,
VGPrincipalSortByColumnType sortBy,
VGSortOrderType sortOrder,
out int totalRecords
)
Public Function GetAllUsers (
pageIndex As Integer,
pageSize As Integer,
sortBy As VGPrincipalSortByColumnType,
sortOrder As VGSortOrderType,
<OutAttribute> ByRef totalRecords As Integer
) As VGMembershipUserCollection
Parameters
- pageIndex
- Type: SystemInt32
The index of the page of results to return. Use 0 to indicate the first page. - pageSize
- Type: SystemInt32
The size of the page of results to return. pageIndex is zero-based. - sortBy
- Type: VGPrincipalSortByColumnType
Column to sort by - VGPrincipalSortByColumnType - sortOrder
- Type: VGSortOrderType
Sorting Order - Ascedning or descending (VGSortOrderType) - totalRecords
- Type: SystemInt32
The total number of users.
Return Value
Type:
VGMembershipUserCollectionA
VGMembershipUserCollection of
VGMembershipUser objects representing all the users in the repository.
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. |
See Also