SqlMembershipProvider.GetAllUsers Method (Int32, Int32, Int32)
Gets a collection of all the users in the SQL Server membership database.
Assembly: System.Web (in System.Web.dll)
Public Overrides Function GetAllUsers ( pageIndex As Integer, pageSize As Integer, <OutAttribute> ByRef totalRecords As Integer ) As MembershipUserCollection
Parameters
- 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.
- 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 |
|---|---|
| System.ArgumentException | pageIndex is less than zero. - or - pageSize is less than one. - or - pageIndex multiplied by pageSize plus pageSize minus one exceeds Int32.MaxValue. |
This method is called by the Membership class to retrieve user information from the SQL Server database specified in the ASP.NET application's configuration file (Web.config).
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 zero 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. The totalRecords parameter would be set to 13.
The following code example returns a list of users in pages of data with a count of the number of users currently online.
Note |
|---|
This example uses the Membership class to call the SqlMembershipProvider specified as the defaultProvider in the Web.config file. If you need to access the default provider as the type SqlMembershipProvider, you can cast the Provider property of the Membership class. To access other configured providers as a specific provider type, you can access them by their configured name with the Providers property of the Membership class and cast them as the specific provider type. |
<%@ Page Language="VB" %> <%@ Import Namespace="System.Web.Security" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> Dim pageSize As Integer = 5 Dim totalUsers As Integer Dim totalPages As Integer Dim currentPage As Integer = 1 Public Sub Page_Load() If Not IsPostBack Then GetUsers() End If End Sub Private Sub GetUsers() UsersOnlineLabel.Text = Membership.GetNumberOfUsersOnline().ToString() UserGrid.DataSource = Membership.GetAllUsers(currentPage-1, pageSize, totalUsers) totalPages = ((totalUsers - 1) \ pageSize) + 1 ' Ensure that we do not navigate past the last page of users. If currentPage > totalPages Then currentPage = totalPages GetUsers() Return End If UserGrid.DataBind() CurrentPageLabel.Text = currentPage.ToString() TotalPagesLabel.Text = totalPages.ToString() If currentPage = totalPages Then NextButton.Visible = False Else NextButton.Visible = True End If If currentPage = 1 Then PreviousButton.Visible = False Else PreviousButton.Visible = True End If If totalUsers <= 0 Then NavigationPanel.Visible = False Else NavigationPanel.Visible = True End If End SUb Public Sub NextButton_OnClick(sender As Object, args As EventArgs) currentPage = Convert.ToInt32(CurrentPageLabel.Text) currentPage += 1 GetUsers() End Sub Public Sub PreviousButton_OnClick(sender As Object, args As EventArgs) currentPage = Convert.ToInt32(CurrentPageLabel.Text) currentPage -= 1 GetUsers() End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head> <title>Sample: Find Users</title> </head> <body> <form id="form1" runat="server"> <h3>User List</h3> Number of Users Online: <asp:Label id="UsersOnlineLabel" runat="Server" /><br /> <asp:Panel id="NavigationPanel" Visible="false" runat="server"> <table border="0" cellpadding="3" cellspacing="3"> <tr> <td style="width:100">Page <asp:Label id="CurrentPageLabel" runat="server" /> of <asp:Label id="TotalPagesLabel" runat="server" /></td> <td style="width:60"><asp:LinkButton id="PreviousButton" Text="< Prev" OnClick="PreviousButton_OnClick" runat="server" /></td> <td style="width:60"><asp:LinkButton id="NextButton" Text="Next >" OnClick="NextButton_OnClick" runat="server" /></td> </tr> </table> </asp:Panel> <asp:DataGrid id="UserGrid" runat="server" CellPadding="2" CellSpacing="1" Gridlines="Both"> <HeaderStyle BackColor="darkblue" ForeColor="white" /> </asp:DataGrid> </form> </body> </html>
Available since 2.0
