SqlRoleProvider.GetUsersInRole Method (String)

 

Gets a list of users in the specified role.

Namespace:   System.Web.Security
Assembly:  System.Web (in System.Web.dll)

override GetUsersInRole : 
        roleName:string -> string[]

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
System.ArgumentNullException

roleName is null.

System.ArgumentException

roleName is an empty string or contains a comma.

-or-

roleName is longer than 256 characters.

System.Configuration.Provider.ProviderException

rolename was not found in the database.

-or-

An unknown error occurred while communicating with the database.

The GetUsersInRole method is called by the Roles class to retrieve the list of users associated with the specified role in the SQL Server database specified in the ASP.NET application's configuration file (Web.config).

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 SqlRoleProvider.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
Show: