Roles.GetRolesForUser Method (String)
Gets a list of the roles that a user is in.
Assembly: System.Web (in System.Web.dll)
Parameters
- username
-
Type:
System.String
The user to return a list of roles for.
Return Value
Type: System.String[]A string array containing the names of all the roles that the specified user is in.
| Exception | Condition |
|---|---|
| System.ArgumentNullException | username is null. |
| System.ArgumentException | username contains a comma (,). |
| System.Configuration.Provider.ProviderException | Role management is not enabled. |
The GetRolesForUser method calls the RoleProvider.GetRolesForUser method of the default role provider to retrieve from the data source the roles that the user is in. Only the roles for the application that is specified in the ApplicationName property are retrieved.
If username is equal to the current logged-on user and CacheRolesInCookie is true, the results of the GetRolesForUser method may be returned from the role cache rather than the specified Provider.
The following code example uses the GetRolesForUser method to retrieve a list of roles for a specified user and bind the returned roles to a System.Web.UI.WebControls.GridView control. For an example of a Web.config file that enables role management, see Roles.
<%@ Page Language="C#" %> <%@ 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"> string[] rolesArray; public void Page_Load() { if (!IsPostBack) { // Bind roles to GridView. try { rolesArray = Roles.GetRolesForUser(); } catch (HttpException e) { Msg.Text = "There is no current logged on user. Role information cannot be retrieved."; return; } UserRolesGrid.Columns[0].HeaderText = "Roles for " + User.Identity.Name; UserRolesGrid.DataSource = rolesArray; UserRolesGrid.DataBind(); } } </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head> <title>Sample: View User Roles</title> </head> <body> <form runat="server" id="PageForm"> <h3>View User Roles</h3> <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br /> <table border="0" cellspacing="4"> <tr> <td valign="top"><asp:GridView runat="server" CellPadding="4" id="UserRolesGrid" AutoGenerateColumns="false" Gridlines="None" CellSpacing="0" > <HeaderStyle BackColor="navy" ForeColor="white" /> <Columns> <asp:TemplateField HeaderText="Roles" > <ItemTemplate> <%# Container.DataItem.ToString() %> </ItemTemplate> </asp:TemplateField> </Columns> </asp:GridView></td> </tr> </table> </form> </body> </html>
Available since 2.0