Roles.RemoveUserFromRoles Method (String, String[])

 

Removes the specified user from the specified roles.

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

static member RemoveUserFromRoles : 
        username:string *
        roleNames:string[] -> unit

Parameters

username
Type: System.String

The user to remove from the specified roles.

roleNames
Type: System.String[]

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

Exception Condition
System.ArgumentNullException

One of the roles in roleNames is null.

-or-

username is null.

System.ArgumentException

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.

System.Configuration.Provider.ProviderException

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.

The following code example uses the RemoveUserFromRoles method to remove a user from one or more roles. 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: