This documentation is archived and is not being maintained.

SqlRoleProvider.RemoveUsersFromRoles Method

Removes the specified user names from 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.

Parameters

usernames
Type: System.String[]

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

roleNames
Type: System.String[]

A string array of role names to remove the specified user names from.

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-

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 user names was not found.

-or-

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

-or-

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

-or-

An unknown error occurred while communicating with the database.

The RemoveUsersFromRoles method is called by the Roles class to remove one or more users from 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 RemoveUserFromRole, RemoveUserFromRoles, RemoveUsersFromRole, and RemoveUsersFromRoles methods of the Roles class.

The database updates that are performed during the call to RemoveUsersFromRoles are made within a transaction. If an error is encountered, such as a user name that does not exist or a user name that is already in a specified role, the transaction is rolled back and no updates are performed.

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.

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.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: