Export (0) Print
Expand All

Roles.AddUsersToRoles Method

Adds the specified users to the specified roles.

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

static member AddUsersToRoles : 
        usernames:string[] * 
        roleNames:string[] -> unit

Parameters

usernames
Type: System.String[]

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

roleNames
Type: System.String[]

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

ExceptionCondition
System.ArgumentNullException

One of the roles in roleNames is a null reference (Nothing in Visual Basic).

-or-

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

System.ArgumentException

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

-or-

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

-or-

roleNames contains a duplicate element.

-or-

usernames contains a duplicate element.

System.Configuration.Provider.ProviderException

Role management is not enabled.

The AddUsersToRoles method calls the default role provider to associate the specified users 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 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 one or more roles. 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.6, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft