RoleProvider.GetUsersInRole Method (String)

 

Gets a list of users in the specified role for the configured applicationName.

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

abstract GetUsersInRole : 
        roleName:string -> string[]

Parameters

roleName
Type: System.String

The name of the role to get the list of users for.

Return Value

Type: System.String[]

A string array containing the names of all the users who are members of the specified role for the configured applicationName.

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

If the specified role name does not exist for the configured applicationName or if it is null or an empty string, we recommend that your provider throw an exception.

If no users are associated with the specified role for the configured applicationName, we recommend that your provider return a string array with no elements.

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

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

.NET Framework
Available since 2.0
Return to top
Show: