Roles.AddUsersToRoles Method

Adds the specified users to the specified roles.

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

No code example is currently available or this language may not be supported.
public static void AddUsersToRoles (
	String[] usernames, 
	String[] roleNames
)
public static function AddUsersToRoles (
	usernames : String[], 
	roleNames : String[]
)
Not applicable.

Parameters

usernames

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

roleNames

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

Exception typeCondition

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.

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: