RoleProvider.AddUsersToRoles Method
Adds the specified user names to the specified roles for the configured applicationName.
Assembly: System.Web (in System.Web.dll)
'Declaration Public MustOverride Sub AddUsersToRoles ( _ usernames As String(), _ roleNames As String() _ ) 'Usage Dim instance As RoleProvider Dim usernames As String() Dim roleNames As String() instance.AddUsersToRoles(usernames, roleNames)
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 the role names to add the specified user names to.
AddUsersToRoles is called by the Roles class to associate the specified users with the specified roles at the data source. Roles are added to the configured ApplicationName.
If any of the specified role names are not found for the configured applicationName, we recommend that your provider throw a ProviderException.
If any of the specified user names are not associated with any of the specified role names for the configured applicationName, we recommend that your provider throw a ProviderException.
If any of the specified user names is Nothing or is an empty string, we recommend that your provider throw an exception.
If any of the specified role names is Nothing or is an empty string, we recommend that your provider throw an exception.
If your data source supports transactions, we recommend that you include each add operation in a transaction and that you roll back the transaction and throw an exception if any add operation fails.
The following code example shows a sample implementation of the AddUsersToRoles method.
Public Overrides Sub AddUsersToRoles(usernames As String(), rolenames As String()) For Each rolename As String In rolenames If rolename Is Nothing OrElse rolename = "" Then _ Throw New ProviderException("Role name cannot be empty or null.") If Not RoleExists(rolename) Then _ Throw New ProviderException("Role name not found.") Next For Each username As String in usernames If username Is Nothing OrElse username = "" Then _ Throw New ProviderException("User name cannot be empty or null.") If username.Contains(",") Then _ Throw New ArgumentException("User names cannot contain commas.") For Each rolename As String In rolenames If IsUserInRole(username, rolename) Then Throw New ProviderException("User is already in role.") End If Next Next Dim conn As OdbcConnection = New OdbcConnection(connectionString) Dim cmd As OdbcCommand = New OdbcCommand("INSERT INTO UsersInRoles " & _ " (Username, Rolename, ApplicationName) " & _ " Values(?, ?, ?)", conn) Dim userParm As OdbcParameter = cmd.Parameters.Add("@Username", OdbcType.VarChar, 255) Dim roleParm As OdbcParameter = cmd.Parameters.Add("@Rolename", OdbcType.VarChar, 255) cmd.Parameters.Add("@ApplicationName", OdbcType.VarChar, 255).Value = ApplicationName Try conn.Open() For Each username As String In usernames For Each rolename As String In rolenames userParm.Value = username roleParm.Value = rolename cmd.ExecuteNonQuery() Next Next Catch e As OdbcException ' Handle exception. Finally conn.Close() End Try End Sub
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.