Roles.AddUserToRole Method

Adds the specified user to the specified role.

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

public:
static void AddUserToRole (
	String^ username, 
	String^ roleName
)
public static void AddUserToRole (
	String username, 
	String roleName
)
public static function AddUserToRole (
	username : String, 
	roleName : String
)
Not applicable.

Parameters

username

The user name to add to the specified role.

roleName

The role to add the specified user name to.

Exception typeCondition

System.ArgumentNullException

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

-or-

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

System.ArgumentException

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

-or-

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

System.Configuration.Provider.ProviderException

Role management is not enabled.

The AddUserToRole method calls the default role provider to associate the specified user with the specified role at the data source.

NoteNote:

User names and role names cannot contain commas.

The following code example adds a user to 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.

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: