Roles.GetRolesForUser Method ()
Gets a list of the roles that the currently logged-on user is in.
Assembly: System.Web (in System.Web.dll)
Return Value
Type: System.String[]A string array containing the names of all the roles that the currently logged-on user is in.
| Exception | Condition |
|---|---|
| System.ArgumentNullException | There is no current logged-on user. |
| 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 currently logged-on user is in. The currently logged-on user is identified by the 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.
Available since 2.0