Roles.RemoveUsersFromRole Method (String[], String)

 

Removes the specified users from the specified role.

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

static member RemoveUsersFromRole : 
        usernames:string[] *
        roleName:string -> unit

Parameters

usernames
Type: System.String[]

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

roleName
Type: System.String

The name of the role to remove the specified users from.

Exception Condition
System.ArgumentNullException

roleName is null.

-or-

One of the user names in usernames is null.

System.ArgumentException

roleName is an empty string or contains a comma (,).

-or-

One of the user names in usernames is an empty string or contains a comma (,).

-or-

usernames contains a duplicate element.

System.Configuration.Provider.ProviderException

Role management is not enabled.

The RemoveUsersFromRole method calls the default role provider to remove the specified users from the specified role 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 RemoveUsersFromRole method to remove one or more users from a role. 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: