Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

RoleProvider.GetAllRoles Method

Gets a list of all the roles for the configured applicationName.

Namespace:  System.Web.Security
Assembly:  System.Web.ApplicationServices (in System.Web.ApplicationServices.dll)
'Declaration
Public MustOverride Function GetAllRoles As String()

Return Value

Type: System.String()
A string array containing the names of all the roles stored in the data source for the configured applicationName.

GetAllRoles is called by the GetAllRoles method of the Roles class to retrieve a list of role names from the data source. Only the roles for the specified ApplicationName are retrieved.

If no roles exist 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 GetAllRoles method.

Public Overrides Function GetAllRoles() As String()
    Dim tmpRoleNames As String = "" 

    Dim conn As OdbcConnection = New OdbcConnection(connectionString)
    Dim cmd As OdbcCommand = New OdbcCommand("SELECT Rolename FROM Roles " & _
                                             " WHERE ApplicationName = ?", conn)

    cmd.Parameters.Add("@ApplicationName", OdbcType.VarChar, 255).Value = ApplicationName

    Dim reader As OdbcDataReader = Nothing 

    Try
        conn.Open()

        reader = cmd.ExecuteReader()

        Do While reader.Read()
            tmpRoleNames &= reader.GetString(0) & "," 
        Loop 
    Catch e As OdbcException
        ' Handle exception. 
    Finally 
        If Not reader Is Nothing Then reader.Close()
        conn.Close()
    End Try 

    If tmpRoleNames.Length > 0 Then 
        ' Remove trailing comma.
        tmpRoleNames = tmpRoleNames.Substring(0, tmpRoleNames.Length - 1)
        Return tmpRoleNames.Split(CChar(","))
    End If 

    Return New String() {}
End Function

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.