AuthorizationStoreRoleProvider.GetRolesForUser Method (String)

 

Gets a list of the roles that a user is in.

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

override GetRolesForUser : 
        username:string -> string[]

Parameters

username
Type: System.String

The user to return a list of roles for.

Return Value

Type: System.String[]

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

Exception Condition
ArgumentNullException

username is null.

ArgumentException

username contains a comma.

ProviderException

The configured applicationName was not found.

-or-

The configured scopeName was not found.

-or-

The authorization-manager runtime is not installed on the server.

FileNotFoundException

The connectionStringName attribute references a connection string to a file that does not exist.

HttpException

The AuthorizationStoreRoleProvider instance is configured with a file-based policy store, and read access to the file is not allowed at the current trust level.

The GetRolesForUser method is called by the Roles class to retrieve a list of a specified user's roles from the authorization-manager policy store specified in the ASP.NET application's configuration file (Web.config).

The following code example uses the GetRolesForUser method to retrieve a list of roles for a specified user and binds them to a System.Web.UI.WebControls.GridView control. For an example of a Web.config file that enables role management, see AuthorizationStoreRoleProvider.

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

.NET Framework
Available since 2.0
Return to top
Show: