Roles.RemoveUserFromRoles Method
Assembly: System.Web (in system.web.dll)
public static void RemoveUserFromRoles ( String username, String[] roleNames )
public static function RemoveUserFromRoles ( username : String, roleNames : String[] )
Not applicable.
Parameters
- username
The user to remove from the specified roles.
- roleNames
A string array of role names to remove the specified user from.
| Exception type | Condition |
|---|---|
|
One of the roles in roleNames is a null reference (Nothing in Visual Basic). -or- username is a null reference (Nothing in Visual Basic). | |
|
One of the roles in roleNames is an empty string or contains a comma (,). -or- username is an empty string or contains a comma (,). -or- roleNames contains a duplicate element. | |
|
Role management is not enabled. |
The RemoveUserFromRoles method calls the default role provider to remove the specified user from the specified roles at the data source.
If the application is configured to use the SqlRoleProvider class, the database updates that are performed during the call to the RemoveUserFromRoles 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.
Reference
Roles ClassRoles Members
System.Web.Security Namespace