RoleProvider::GetRolesForUser Method (String^)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets a list of the roles that a specified user is in for the configured applicationName.

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

public:
virtual array<String^>^ GetRolesForUser(
	String^ username
) abstract

Parameters

username
Type: System::String^

The user to return a list of roles for.

Return Value

Type: array<System::String^>^

A string array containing the names of all the roles that the specified user is in for the configured applicationName.

GetRolesForUser is called by the GetRolesForUser method of the Roles class to retrieve the role names that the specified user is associated with from the data source. Only the roles for the configured ApplicationName are retrieved.

If no roles exist for the specified user for the configured applicationName, we recommend that your provider return a string array with no elements.

If the specified user name is null or is an empty string, we recommend that your provider throw an exception.

The following code example shows a sample implementation of the GetRolesForUser method.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
Show: