Roles.AddUsersToRole Method (String[], String)


Adds the specified users to the specified role.

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

static member AddUsersToRole : 
        usernames:string[] *
        roleName:string -> unit


Type: System.String[]

A string array of user names to add to the specified role.

Type: System.String

The role to add the specified user names to.

Exception Condition

roleName is null.


One of the elements in usernames is null.


roleName is an empty string or contains a comma (,).


One of the elements in usernames is an empty string or contains a comma (,).


usernames contains a duplicate element.


Role management is not enabled.

The AddUsersToRole method calls the default role provider to associate the specified users with the specified role at the data source.

If your application uses the SqlRoleProvider class, the database updates that are performed during the call to the AddUsersToRoles method are made within a transaction. If an error is encountered, such as a user name that is already in a specified role, the transaction is rolled back and no updates are performed.


User names and role names cannot contain commas.

The following code example adds one or more users to a role or removes a user from a role based on user input. For an example of a Web.config file that enables role management, see Roles.

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

.NET Framework
Available since 2.0
Return to top