Roles::RemoveUsersFromRoles Method (array<String^>^, array<String^>^)

 

Removes the specified user names from the specified roles.

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

public:
static void RemoveUsersFromRoles(
	array<String^>^ usernames,
	array<String^>^ roleNames
)

Parameters

usernames
Type: array<System::String^>^

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

roleNames
Type: array<System::String^>^

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

Exception Condition
System::ArgumentNullException

One of the roles specified in roleNames is null.

-or-

One of the users specified in usernames is null.

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.

.NET Framework
Available since 2.0
Return to top
Show: