Membership.GetAllUsers Method (Int32, Int32, Int32)
Gets a collection of all the users in the database in pages of data.
Assembly: System.Web (in System.Web.dll)
static member GetAllUsers : pageIndex:int * pageSize:int * totalRecords:int byref -> MembershipUserCollection
Parameters
- pageIndex
-
Type:
System.Int32
The index of the page of results to return. Use 0 to indicate the first page.
- pageSize
-
Type:
System.Int32
The size of the page of results to return. pageIndex is zero-based.
- totalRecords
-
Type:
System.Int32
The total number of users.
Return Value
Type: System.Web.Security.MembershipUserCollectionA MembershipUserCollection of MembershipUser objects representing all the users in the database for the configured applicationName.
| Exception | Condition |
|---|---|
| ArgumentException | pageIndex is less than zero. -or- pageSize is less than 1. |
The results returned by GetAllUsers are constrained by the pageIndex and pageSize parameters. The pageSize parameter identifies the maximum number of MembershipUser objects to return in the MembershipUserCollection. The pageIndex parameter identifies which page of results to return, where 0 identifies the first page. The totalRecords parameter is an out parameter that is set to the total number of membership users for the configured applicationName. For example, if there are 13 users for the configured applicationName, and the pageIndex value was 1 with a pageSize of 5, the MembershipUserCollection returned would contain the sixth through the tenth users returned. totalRecords would be set to 13.
Available since 2.0