Roles.GetRolesForUser Method ()
Assembly: System.Web (in system.web.dll)
'Declaration Public Shared Function GetRolesForUser As String() 'Usage Dim returnValue As String() returnValue = Roles.GetRolesForUser
public static String[] GetRolesForUser ()
public static function GetRolesForUser () : String[]
Not applicable.
Return Value
A string array containing the names of all the roles that the currently logged-on user is in.The GetRolesForUser method calls the RoleProvider.GetRolesForUser method of the default role provider to retrieve from the data source the roles that the currently logged-on user is in. The currently logged-on user is identified by the System.Web.HttpContext.User property of the current System.Web.HttpContext, or by Thread.CurrentPrincipal for non-HTTP hosting environments. If no user is logged on, an exception will be thrown. Only the roles for the application that is specified in the ApplicationName property are retrieved.
If CacheRolesInCookie is true, then the results of the GetRolesForUser method may be returned from the role cache rather than the specified role 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="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 rolesArray() As String Public Sub Page_Load() If Not IsPostBack Then ' Bind roles to GridView. Try rolesArray = Roles.GetRolesForUser() Catch e As HttpException Msg.Text = "There is no current logged on user. Role information cannot be retrieved." Return End Try UserRolesGrid.Columns(0).HeaderText = "Roles for " & User.Identity.Name UserRolesGrid.DataSource = rolesArray UserRolesGrid.DataBind() End If End Sub </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>
Reference
Roles ClassRoles Members
System.Web.Security Namespace