This documentation is archived and is not being maintained.

Roles.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 remove from the specified roles.

roleNames
Type: System.String[]

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

ExceptionCondition
System.ArgumentNullException

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

-or-

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

System.ArgumentException

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

-or-

One of the users specified 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 RemoveUsersFromRoles method calls the default role provider to remove the specified users from the specified roles at the data source.

If the application uses the SqlRoleProvider class, the database updates that are performed during the call to the RemoveUsersFromRoles method are made within a transaction. If an error is encountered, such as a user name that is not in a specified role, the transaction is rolled back and no updates are performed.

The following code example uses the RemoveUsersFromRoles method to remove one or more users from one or more roles based on user input. 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 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: