This documentation is archived and is not being maintained.

Roles.AddUsersToRole Method

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 

Parameters

usernames
Type: System.String[]
A string array of user names to add to the specified role.
roleName
Type: System.String
The role to add the specified user names to.

ExceptionCondition
System.ArgumentNullException

roleName is a null reference (Nothing in Visual Basic).

-or-

One of the elements in usernames is a null reference (Nothing in Visual Basic).

System.ArgumentException

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

-or-

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

-or-

usernames contains a duplicate element.

System.Configuration.Provider.ProviderException

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.

NoteNote

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

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: