Roles.RemoveUserFromRoles Method

Removes the specified user 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.
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 typeCondition

System.ArgumentNullException

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

-or-

username is a null reference (Nothing in Visual Basic).

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.

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: