AuthorizationStoreRoleProvider.GetUsersInRole Method (String)
Gets a list of users in the specified role.
Assembly: System.Web (in System.Web.dll)
Parameters
- roleName
-
Type:
System.String
The name of the role to get the list of users for.
Return Value
Type: System.String[]A string array containing the names of all the users who are members of the specified role.
| Exception | Condition |
|---|---|
| ArgumentNullException | roleName is null. |
| ArgumentException | roleName is an empty string. -or- roleName contains a comma. |
| ProviderException | The configured applicationName was not found. -or- The configured scopeName was not found. -or- The authorization-manager runtime is not installed on the server. |
| FileNotFoundException | The connectionStringName attribute references a connection string to a file that does not exist. |
| HttpException | The AuthorizationStoreRoleProvider instance is configured with a file-based policy store, and read access to the file is not allowed at the current trust level. |
The GetUsersInRole method is called by the Roles class to retrieve the list of users associated with the specified role in the authorization-manager policy store specified in the ASP.NET application's configuration file (Web.config).
The GetUsersInRole method only returns user names that are directly contained in the authorization-manager role specified by the roleName parameter. The underlying authorization-manager API called by the GetUsersInRole method does not support group expansion, so users contained in nested NT groups, nested authorization-manager groups, and LDAP query groups will not be returned.
The following code example uses the GetUsersInRole method to get a list of the users in a particular role and bind the results to a System.Web.UI.WebControls.GridView control. For an example of a Web.config file that enables role management, see AuthorizationStoreRoleProvider.
Available since 2.0