AddUserToRoles Method

Roles.AddUserToRoles Method (String, String[])


Adds the specified user to the specified roles.

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

public static void AddUserToRoles(
	string username,
	string[] roleNames


Type: System.String

The user name to add to the specified roles.

Type: System.String[]

A string array of roles to add the specified user name to.

Exception Condition

One of the roles in roleNames is null.


username is null.


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


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


roleNames contains a duplicate element.


Role management is not enabled.

The AddUserToRoles method calls the default role provider to associate the specified user with the specified roles at the data source.

If your application uses the SqlRoleProvider class, the database updates that are performed during the call to the AddUserToRoles 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 a user to one or more roles. For an example of a Web.config file that enables role management, see Roles.

.NET Framework
Available since 2.0
Return to top
© 2015 Microsoft