SqlRoleProvider.AddUsersToRoles Method (String[], String[])

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Adds the specified user names to each of the specified roles.

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

override AddUsersToRoles : 
        usernames:string[] *
        roleNames:string[] -> unit

Parameters

usernames
Type: System.String[]

A string array of user names to be added to the specified roles.

roleNames
Type: System.String[]

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

Exception Condition
System.ArgumentNullException

One of the roles in roleNames is null.

-or-

One of the users in usernames is null.

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-

One of the roles in roleNames is longer than 256 characters.

-or-

One of the users in usernames is longer than 256 characters.

-or-

roleNames contains a duplicate element.

-or-

usernames contains a duplicate element.

System.Configuration.Provider.ProviderException

One or more of the specified role names was not found.

-or-

One or more of the specified user names was not found.

-or-

One or more of the specified user names is already associated with one or more of the specified role names.

-or-

An unknown error occurred while communicating with the database.

The AddUsersToRoles method is called by the Roles class to associate one or more users with one or more roles in the SQL Server database specified in the ASP.NET application's configuration file (Web.config). This method is called by the AddUserToRole, AddUserToRoles, AddUsersToRole, and AddUsersToRoles methods of the Roles 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.

If the SqlRoleProvider is being used with the SqlMembershipProvider, and one of the specified user names does not exist in the database, the user name will be automatically added to the database.

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. For an example of a Web.config file that enables role management, see SqlRoleProvider.

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

.NET Framework
Available since 2.0
Return to top
Show: